Recommendation API — client.sell.recommendation¶
Version v1.1.0 · base path /sell/recommendation/v1 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
find_listing_recommendations ¶
find_listing_recommendations(*, body: FindListingRecommendationRequest | None = None, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_recommendation_models.PagedListingRecommendationCollection
find_listing_recommendations(*, body: FindListingRecommendationRequest | None = None, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
find_listing_recommendations(*, body: FindListingRecommendationRequest | None = None, filter: str | None = None, limit: int | str | None = None, offset: int | str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_recommendation_models.PagedListingRecommendationCollection | httpx.Response
The find method currently returns information for a single recommendation type ( AD ) which contains information that sellers can use to configure Promoted Listings ad campaigns. The response from this method includes an array of the seller's listing IDs, where each element in the array contains recommendations related to the associated listing ID.
Models¶
Basis ¶
BidPercentages ¶
Bases: EbayModel
basis
class-attribute
instance-attribute
¶
basis = Field(None, description='The basis by which the ad rate is calculated. Valid Values: ITEM and TRENDING')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The bid percentage data is a single precision value, as calculated by the associated basis. In Promoted listings ad campaigns, the bid percentage (also known as the ad rate ) is a user-defined value that sets the level that eBay raises the visibility of the listing in the marketplace. It is also the rate that is used to calculate the Promoted Listings fee. Minimum value: 1.0 Maximum value: 100.0')
ErrorParameter ¶
FindListingRecommendationRequest ¶
Bases: EbayModel
listing_ids
class-attribute
instance-attribute
¶
listing_ids = Field(None, alias='listingIds', description='A comma-separated list of listing IDs for which you want Promoted Listings ad configuration information. Currently, this method accepts only listingId values from the Trading API. Max: 500 listing IDs')
PromoteWithAd ¶
Ad ¶
Bases: EbayModel
bid_percentages
class-attribute
instance-attribute
¶
bid_percentages = Field(None, alias='bidPercentages', description='This field returns information that you can use to configure the bidPercentage field in a Promoted Listings campaign. Note: Currently, ITEM and TRENDING are the only supported bid percentage types. The ITEM suggested bid percentages are tailored to each of your items and are designed to help you stay competitive while finding an optimal balance between performance and cost.')
promote_with_ad
class-attribute
instance-attribute
¶
promote_with_ad = Field(None, alias='promoteWithAd', description='An enum whose values describe whether or not eBay recommends you place the associated listing in a Promoted Listings ad campaign. IDs deemed RECOMMENDED by eBay are the listings with the highest potential of benefiting from being promoted. The recommendation calculation is based on marketplace trends, like buyer demand and the competition in the item’s category.')
Error ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies the type of error.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name for the primary system where the error occurred. This is relevant for application errors.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A unique number to identify the error.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description='An array of request elements most closely associated to the error.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="Information on how to correct the problem, in the end user's terms and language where applicable.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='An array of request elements most closely associated to the error.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.')
MarketingRecommendation ¶
Bases: EbayModel
ad
class-attribute
instance-attribute
¶
ad = Field(None, description='An object that contains Promoted Listings recommendations and information related to the associated listing ID.')
message
class-attribute
instance-attribute
¶
message = Field(None, description='A message that can conditionally accompany the listing information.')
ListingRecommendation ¶
Bases: EbayModel
listing_id
class-attribute
instance-attribute
¶
listing_id = Field(None, alias='listingId', description='An ID that identifies the active listing associated with the eBay recommendations.')
marketing
class-attribute
instance-attribute
¶
marketing = Field(None, description='This return object provides the eBay recommendations and information related to the associated listing ID. The container currently returns the AD recommendation type, which contains information that sellers can use to configure Promoted Listings ad campaigns.')
PagedListingRecommendationCollection ¶
Bases: EbayModel
href
class-attribute
instance-attribute
¶
href = Field(None, description='The URI of the current page of results from the result set.')
limit
class-attribute
instance-attribute
¶
limit = Field(None, description='The number of items returned on a single page from the result set. This value can be set in the request with the limit query parameter.')
listing_recommendations
class-attribute
instance-attribute
¶
listing_recommendations = Field(None, alias='listingRecommendations', description='Returns a list of listingRecommendations , where each element in the list offers recommendations for the associated listingId . Which elements are returned depend on how you structure the request.')
next
class-attribute
instance-attribute
¶
next = Field(None, description='The URI for the following page of results. This value is returned only if there is an additional page of results to display from the result set. Max length : 2048')
offset
class-attribute
instance-attribute
¶
offset = Field(None, description='The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter. Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0 .')
prev
class-attribute
instance-attribute
¶
prev = Field(None, description='The URI for the preceding page of results. This value is returned only if there is a previous page of results to display from the result set. Max length : 2048')
total
class-attribute
instance-attribute
¶
total = Field(None, description='The total number of items retrieved in the result set. If no items are found, this field is returned with a value of 0 .')