From f5d2d0197b1d8cb940228983e15a77983b2071e4 Mon Sep 17 00:00:00 2001 From: diPhantxm Date: Sun, 2 Mar 2025 15:28:41 +0300 Subject: [PATCH] update --- ozon/analytics.go | 116 +++++++++++++++++++++++++++++++++++++++-- ozon/analytics_test.go | 71 +++++++++++++++++++++++++ ozon/finance.go | 6 +-- ozon/warehouses.go | 3 +- 4 files changed, 186 insertions(+), 10 deletions(-) diff --git a/ozon/analytics.go b/ozon/analytics.go index 88e269d..e8c003e 100644 --- a/ozon/analytics.go +++ b/ozon/analytics.go @@ -200,12 +200,9 @@ type GetStocksOnWarehousesResultRow struct { // Name of the warehouse where the products are stored WarehouseName string `json:"warehouse_name"` - - // Number of days the stock will last based on your average daily sales - IDC float64 `json:"idc"` } -// Report on stocks and products movement at Ozon warehouses +// Method for getting a report on leftover stocks and products movement at Ozon warehouses func (c Analytics) GetStocksOnWarehouses(ctx context.Context, params *GetStocksOnWarehousesParams) (*GetStocksOnWarehousesResponse, error) { url := "/v2/analytics/stock_on_warehouses" @@ -340,3 +337,114 @@ func (c Analytics) Stock(ctx context.Context, params *GetStockManagementParams) return resp, nil } + +type GetProductQueriesParams struct { + // Date when analytics generation starts + DateFrom string `json:"date_from"` + + //Date when analytics generation ends + DateTo string `json:"date_to"` + + // Number of page returned in the request + Page int32 `json:"page"` + + // Number of items on the pag + PageSize int32 `json:"page_size"` + + // List of SKUs—product identifiers in the Ozon system. + // Analytics on requests is returned for them. + // Maximum value is 1,000 SKUs + SKUs []string `json:"skus"` + + // Parameter by which products are sorted + SortBy string `json:"sort_by"` + + // Sorting direction + SortDir string `json:"sort_dir"` +} + +type GetProductQueriesResponse struct { + core.CommonResponse + + // Period for which the analytics is generated + AnalyticsPeriod AnalyticsPeriod `json:"analytics_period"` + + // Product list + Items []GetProductQueriesItem `json:"items"` + + // Number of pages + PageCount int64 `json:"page_count"` + + // Total number of queries + Total int64 `json:"total"` +} + +type AnalyticsPeriod struct { + // Date when analytics generation starts + DateFrom string `json:"date_from"` + + // Date when analytics generation ends + DateTo string `json:"date_to"` +} + +type GetProductQueriesItem struct { + // Category name + Category string `json:"category"` + + // Currency + Currency string `json:"currency"` + + // Sales by queries + GMV float64 `json:"gmv"` + + // Product name + Name string `json:"name"` + + // Product identifier in the seller's system + OfferId string `json:"offer_id"` + + // Average product position. Available only with the Premium or Premium Plus subscription, otherwise the field returns empty + Position float64 `json:"position"` + + // Product identifier in the Ozon system, SKU + SKU int64 `json:"sku"` + + // Number of customers who searched for your product on Ozon + UniqueSearchUsers int64 `json:"unique_search_users"` + + // Number of customers who have seen your product on Ozon. + // Available only with the Premium or Premium Plus subscription, + // otherwise the field returns empty + UniqueViewUsers int64 `json:"unique_view_users"` + + // Conversion from product views. + // Available only with the Premium or Premium Plus subscription, + // otherwise the field returns empty + ViewConversion float64 `json:"view_conversion"` +} + +// Use the method to get data about your product queries. +// Full analytics is available with the Premium and Premium Plus subscription. +// Without subscription, you can see a part of the metrics. +// The method is similar to the Products in Search → Queries for my product tab in your personal account. +// +// You can view analytics by queries for certain dates. +// To do this, specify the interval in the date_from and date_to fields. +// Data for the last month are available in any interval except for +// three days from the current date because these days the calculation is performed. +// Analytics for dates later than a month ago is available only with +// the Premium and Premium Plus subscription, and only by weeks. +// Specify the date_from parameter in the request +func (c Analytics) GetProductQueries(ctx context.Context, params *GetProductQueriesParams) (*GetProductQueriesResponse, error) { + url := "/v1/analytics/product-queries" + + resp := &GetProductQueriesResponse{} + + response, err := c.client.Request(ctx, http.MethodPost, url, params, resp, nil) + if err != nil { + return nil, err + } + response.CopyCommonResponse(&resp.CommonResponse) + + return resp, nil +} diff --git a/ozon/analytics_test.go b/ozon/analytics_test.go index 78607b4..a19f902 100644 --- a/ozon/analytics_test.go +++ b/ozon/analytics_test.go @@ -277,3 +277,74 @@ func TestGetStock(t *testing.T) { } } } + +func TestGetProductQueries(t *testing.T) { + t.Parallel() + + tests := []struct { + statusCode int + headers map[string]string + params *GetProductQueriesParams + response string + }{ + // Test Ok + { + http.StatusOK, + map[string]string{"Client-Id": "my-client-id", "Api-Key": "my-api-key"}, + &GetProductQueriesParams{ + Page: 1, + PageSize: 10, + SKUs: []string{"string"}, + }, + `{ + "analytics_period": { + "date_from": "string", + "date_to": "string" + }, + "items": [ + { + "category": "string", + "currency": "string", + "gmv": 0, + "name": "string", + "offer_id": "string", + "position": 0, + "sku": 0, + "unique_search_users": 0, + "unique_view_users": 0, + "view_conversion": 0 + } + ], + "page_count": 0, + "total": 0 + }`, + }, + // Test No Client-Id or Api-Key + { + http.StatusUnauthorized, + map[string]string{}, + &GetProductQueriesParams{}, + `{ + "code": 16, + "message": "Client-Id and Api-Key headers are required" + }`, + }, + } + + for _, test := range tests { + c := NewMockClient(core.NewMockHttpHandler(test.statusCode, test.response, test.headers)) + + ctx, _ := context.WithTimeout(context.Background(), testTimeout) + resp, err := c.Analytics().GetProductQueries(ctx, test.params) + if err != nil { + t.Error(err) + continue + } + + compareJsonResponse(t, test.response, &GetProductQueriesResponse{}) + + if resp.StatusCode != test.statusCode { + t.Errorf("got wrong status code: got: %d, expected: %d", resp.StatusCode, test.statusCode) + } + } +} diff --git a/ozon/finance.go b/ozon/finance.go index 71b1ca1..afadd5b 100644 --- a/ozon/finance.go +++ b/ozon/finance.go @@ -362,11 +362,7 @@ type ListTransactionsResultOperationItem struct { } type ListTransactionsResultOperationPosting struct { - // Delivery scheme: - // - FBO — delivery to Ozon warehouse - // - FBS — delivery from seller's warehouse - // - RFBS — delivery service of seller's choice - // - Crossborder — delivery from abroad + // Delivery scheme DeliverySchema string `json:"delivery_schema"` // Date the product was accepted for processing diff --git a/ozon/warehouses.go b/ozon/warehouses.go index bf18346..c9ca3cb 100644 --- a/ozon/warehouses.go +++ b/ozon/warehouses.go @@ -88,7 +88,8 @@ type GetListOfWarehousesResultFirstMile struct { FirstMileType string `json:"first_mile_type"` } -// You do not need to specify any parameters in the request. Your company will be identified by the Warehouses ID +// Method returns the list of FBS and rFBS warehouses. +// To get the list of FBO warehouses, use the /v1/cluster/list method. func (c Warehouses) GetListOfWarehouses(ctx context.Context) (*GetListOfWarehousesResponse, error) { url := "/v1/warehouse/list"