Files
Sipro-Marketplaces/pkg/api/yandex/ymclient/docs/RatingsAPI.md
2025-08-15 11:10:28 +03:00

6.9 KiB
Raw Blame History

\RatingsAPI

All URIs are relative to https://api.partner.market.yandex.ru

Method HTTP request Description
GetQualityRatingDetails Post /campaigns/{campaignId}/ratings/quality/details Заказы, которые повлияли на индекс качества
GetQualityRatings Post /businesses/{businessId}/ratings/quality Индекс качества магазинов

GetQualityRatingDetails

GetQualityRatingDetailsResponse GetQualityRatingDetails(ctx, campaignId).Execute()

Заказы, которые повлияли на индекс качества

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	campaignId := int64(789) // int64 | Идентификатор кампании.  Его можно узнать с помощью запроса [:no-translate[GET campaigns]](:no-translate[../../reference/campaigns/getCampaigns.md]) или найти в кабинете продавца на Маркете — нажмите на название своего бизнеса и перейдите на страницу:    * **Модули и :no-translate[API]** → блок **Передача данных Маркету**.   * **Лог запросов** → выпадающий список в блоке **Показывать логи**.  ⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах. 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RatingsAPI.GetQualityRatingDetails(context.Background(), campaignId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RatingsAPI.GetQualityRatingDetails``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetQualityRatingDetails`: GetQualityRatingDetailsResponse
	fmt.Fprintf(os.Stdout, "Response from `RatingsAPI.GetQualityRatingDetails`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
campaignId int64 Идентификатор кампании. Его можно узнать с помощью запроса :no-translate[GET campaigns] или найти в кабинете продавца на Маркете — нажмите на название своего бизнеса и перейдите на страницу: * Модули и :no-translate[API] → блок Передача данных Маркету. * Лог запросов → выпадающий список в блоке Показывать логи. ⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.

Other Parameters

Other parameters are passed through a pointer to a apiGetQualityRatingDetailsRequest struct via the builder pattern

Name Type Description Notes

Return type

GetQualityRatingDetailsResponse

Authorization

ApiKey, OAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

GetQualityRatings

GetQualityRatingResponse GetQualityRatings(ctx, businessId).GetQualityRatingRequest(getQualityRatingRequest).Execute()

Индекс качества магазинов

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	businessId := int64(789) // int64 | Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом [:no-translate[GET campaigns]](:no-translate[../../reference/campaigns/getCampaigns.md]).   [Что такое кабинет и магазин на Маркете](:no-translate[https://yandex.ru/support/marketplace/account/introduction.html]) 
	getQualityRatingRequest := *openapiclient.NewGetQualityRatingRequest([]int64{int64(123)}) // GetQualityRatingRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.RatingsAPI.GetQualityRatings(context.Background(), businessId).GetQualityRatingRequest(getQualityRatingRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RatingsAPI.GetQualityRatings``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetQualityRatings`: GetQualityRatingResponse
	fmt.Fprintf(os.Stdout, "Response from `RatingsAPI.GetQualityRatings`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
businessId int64 Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом :no-translate[GET campaigns]. Что такое кабинет и магазин на Маркете

Other Parameters

Other parameters are passed through a pointer to a apiGetQualityRatingsRequest struct via the builder pattern

Name Type Description Notes

getQualityRatingRequest | GetQualityRatingRequest | |

Return type

GetQualityRatingResponse

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]