OpenAPI\Client\BidsApi

All URIs are relative to https://api.partner.market.yandex.ru, except if the operation defines another base path.

Method	HTTP request	Description
getBidsInfoForBusiness()	POST /businesses/{businessId}/bids/info	Информация об установленных ставках
getBidsRecommendations()	POST /businesses/{businessId}/bids/recommendations	Рекомендованные ставки для заданных товаров
putBidsForBusiness()	PUT /businesses/{businessId}/bids	Включение буста продаж и установка ставок
putBidsForCampaign()	PUT /campaigns/{campaignId}/bids	Включение буста продаж и установка ставок для магазина

`getBidsInfoForBusiness()`

getBidsInfoForBusiness($business_id, $page_token, $limit, $get_bids_info_request): \OpenAPI\Client\Model\GetBidsInfoResponse

Информация об установленных ставках

Возвращает значения ставок для заданных товаров. {% note warning "Получить информацию по кампаниям, созданным в кабинете, не получится" %} В ответе возвращаются значения только тех ставок, которые вы установили через запрос PUT businesses/{businessId}/bids. {% endnote %} В одном запросе может быть максимум 1500 товаров. |⚙️ Лимит: 1000 запросов в минуту| |-|

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');

// Configure OAuth2 access token for authorization: OAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\BidsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$business_id = 56; // int | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).  ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
$page_token = eyBuZXh0SWQ6IDIzNDIgfQ==; // string | Идентификатор страницы c результатами.  Если параметр не указан, возвращается первая страница.  Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.  Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.
$limit = 20; // int | Количество значений на одной странице.
$get_bids_info_request = new \OpenAPI\Client\Model\GetBidsInfoRequest(); // \OpenAPI\Client\Model\GetBidsInfoRequest | description

try {
    $result = $apiInstance->getBidsInfoForBusiness($business_id, $page_token, $limit, $get_bids_info_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BidsApi->getBidsInfoForBusiness: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
business_id	int	Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
page_token	string	Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются.	[optional]
limit	int	Количество значений на одной странице.	[optional]
get_bids_info_request	\OpenAPI\Client\Model\GetBidsInfoRequest	description	[optional]

Return type

\OpenAPI\Client\Model\GetBidsInfoResponse

Authorization

ApiKey, OAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getBidsRecommendations()`

getBidsRecommendations($business_id, $get_bids_recommendations_request): \OpenAPI\Client\Model\GetBidsRecommendationsResponse

Рекомендованные ставки для заданных товаров

Возвращает рекомендованные ставки для заданных товаров — такие ставки обеспечивают вашим предложениям определенную долю показов и дополнительные инструменты продвижения. Для одного товара может возвращаться одна рекомендованная ставка или несколько. Во втором случае разные ставки предназначены для достижения разной доли показов и дополнительных инструментов продвижения. Если товар только добавлен в каталог, но пока не продается, рекомендованной ставки для него не будет. В одном запросе может быть максимум 1500 товаров. |⚙️ Лимит: 1000 запросов в минуту| |-|

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');

// Configure OAuth2 access token for authorization: OAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\BidsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$business_id = 56; // int | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).  ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
$get_bids_recommendations_request = new \OpenAPI\Client\Model\GetBidsRecommendationsRequest(); // \OpenAPI\Client\Model\GetBidsRecommendationsRequest | description.

try {
    $result = $apiInstance->getBidsRecommendations($business_id, $get_bids_recommendations_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BidsApi->getBidsRecommendations: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
business_id	int	Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
get_bids_recommendations_request	\OpenAPI\Client\Model\GetBidsRecommendationsRequest	description.

Return type

\OpenAPI\Client\Model\GetBidsRecommendationsResponse

Authorization

ApiKey, OAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`putBidsForBusiness()`

putBidsForBusiness($business_id, $put_sku_bids_request): \OpenAPI\Client\Model\ApiResponse

Включение буста продаж и установка ставок

Запускает буст продаж — создает и включает кампанию, добавляет в нее товары и назначает на них ставки. {% cut "Как в кабинете выглядит кампания, созданная через API" %} {% endcut %} При первом использовании запроса Маркет: создаст единую на все магазины бизнес-аккаунта кампанию, добавит в нее товары с указанными ставками, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов. Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой. Запрос всегда работает с одной и той же созданной через API кампанией. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. Другими кампаниями управлять через API не получится. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя. Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены. Внести другие изменения в созданную через API кампанию можно в кабинете: * выключить или включить кампанию; * изменить ее название; * выключить или включить ценовую стратегию. Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid. Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов. {% note info "Как посмотреть расходы на буст продаж?" %} Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee. {% endnote %} В одном запросе может быть максимум 1500 товаров. |⚙️ Лимит: 1000 запросов в минуту| |-|

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');

// Configure OAuth2 access token for authorization: OAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\BidsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$business_id = 56; // int | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).  ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
$put_sku_bids_request = new \OpenAPI\Client\Model\PutSkuBidsRequest(); // \OpenAPI\Client\Model\PutSkuBidsRequest | description

try {
    $result = $apiInstance->putBidsForBusiness($business_id, $put_sku_bids_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BidsApi->putBidsForBusiness: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
business_id	int	Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
put_sku_bids_request	\OpenAPI\Client\Model\PutSkuBidsRequest	description

Return type

\OpenAPI\Client\Model\ApiResponse

Authorization

ApiKey, OAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`putBidsForCampaign()`

putBidsForCampaign($campaign_id, $put_sku_bids_request): \OpenAPI\Client\Model\ApiResponse

Включение буста продаж и установка ставок для магазина

Запускает буст продаж в указанном магазине — создает и включает кампанию, добавляет в нее товары и назначает на них ставки. При первом использовании запроса Маркет: создаст кампанию, добавит в нее товары с указанными ставками для заданного магазина, включит для них ценовую стратегию и запустит продвижение. Повторное использование запроса позволит обновить ставки на товары в этой кампании или добавить новые. Подробнее о ценовой стратегии читайте в Справке Маркета для продавцов. Если товара с указанным SKU нет, он будет проигнорирован. Если в будущем в каталоге появится товар с таким SKU, он автоматически будет добавлен в кампанию с указанной ставкой. Запрос всегда работает с одной и той же кампанией, созданной через этот запрос или PUT businesses/{businessId}/bids. Если в кабинете удалить ее, при следующем выполнении запроса Маркет создаст новую. У созданной через API кампании всегда наибольший приоритет над остальными — изменить его нельзя. Выполнение запроса включает кампанию и ценовую стратегию, если они были отключены. Внести другие изменения в созданную через API кампанию можно в кабинете: * выключить или включить кампанию; * изменить ее название; * выключить или включить ценовую стратегию. Чтобы остановить продвижение отдельных товаров и удалить их из кампании, передайте для них нулевую ставку в параметре bid. Подробнее о том, как работает буст продаж, читайте в Справке Маркета для продавцов. {% note info "Как посмотреть расходы на буст продаж?" %} Фактические расходы на буст указаны в отчете по заказам (POST campaigns/{campaignId}/stats/orders). Сумма содержится в поле bidFee. {% endnote %} В одном запросе может быть максимум 1500 товаров. |⚙️ Лимит: 1000 запросов в минуту| |-|

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Api-Key', 'Bearer');

// Configure OAuth2 access token for authorization: OAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\BidsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$campaign_id = 56; // int | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.  Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).  ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
$put_sku_bids_request = new \OpenAPI\Client\Model\PutSkuBidsRequest(); // \OpenAPI\Client\Model\PutSkuBidsRequest | description

try {
    $result = $apiInstance->putBidsForCampaign($campaign_id, $put_sku_bids_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BidsApi->putBidsForCampaign: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	int	Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
put_sku_bids_request	\OpenAPI\Client\Model\PutSkuBidsRequest	description

Return type

\OpenAPI\Client\Model\ApiResponse

Authorization

ApiKey, OAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

OpenAPI\Client\BidsApi

`getBidsInfoForBusiness()`

Example

Parameters

Return type

Authorization

HTTP request headers

`getBidsRecommendations()`

Example

Parameters

Return type

Authorization

HTTP request headers

`putBidsForBusiness()`

Example

Parameters

Return type

Authorization

HTTP request headers

`putBidsForCampaign()`

Example

Parameters

Return type

Authorization

HTTP request headers

FilesExpand file tree

BidsApi.md

Latest commit

History

BidsApi.md

File metadata and controls

OpenAPI\Client\BidsApi

getBidsInfoForBusiness()

Example

Parameters

Return type

Authorization

HTTP request headers

getBidsRecommendations()

Example

Parameters

Return type

Authorization

HTTP request headers

putBidsForBusiness()

Example

Parameters

Return type

Authorization

HTTP request headers

putBidsForCampaign()

Example

Parameters

Return type

Authorization

HTTP request headers

`getBidsInfoForBusiness()`

`getBidsRecommendations()`

`putBidsForBusiness()`

`putBidsForCampaign()`