Download the PHP package macropage/sdk-ebay-rest-marketing without Composer
On this page you can find all versions of the php package macropage/sdk-ebay-rest-marketing. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download macropage/sdk-ebay-rest-marketing
More information about macropage/sdk-ebay-rest-marketing
Files in macropage/sdk-ebay-rest-marketing
Package sdk-ebay-rest-marketing
Short Description
The Marketing API offers two platforms that sellers can use to promote and advertise their products:
- Promoted Listings is an eBay ad service that lets sellers set up ad campaigns for the products they want to promote. eBay displays the ads in search results and in other marketing modules as SPONSORED listings. If an item in a Promoted Listings campaign sells, the seller is assessed a Promoted Listings fee, which is a seller-specified percentage applied to the sales price. For complete details, refer to the Promoted Listings playbook.
- Promotions Manager gives sellers a way to offer discounts on specific items as a way to attract buyers to their inventory. Sellers can set up discounts (such as "20% off" and other types of offers) on specific items or on an entire customer order. To further attract buyers, eBay prominently displays promotion teasers throughout buyer flows. For complete details, see Promotions Manager.
Marketing reports, on both the Promoted Listings and Promotions Manager platforms, give sellers information that shows the effectiveness of their marketing strategies. The data gives sellers the ability to review and fine tune their marketing efforts.
Store Email Campaign allows sellers to create and send email campaigns to customers who have signed up to receive their newsletter. For more information on email campaigns, see Store Email Campaigns.
Important! Sellers must have an active eBay Store subscription, and they must accept the Terms and Conditions before they can make requests to these APIs in the Production environment. There are also site-specific listings requirements and restrictions associated with these marketing tools, as listed in the "requirements and restrictions" sections for Promoted Listings and Promotions Manager.
The table below lists all the Marketing API calls grouped by resource.
License unlicense
Homepage https://openapi-generator.tech
Informations about the package sdk-ebay-rest-marketing
Important Notice
Before using this SDK, you must modify the OpenAPI specification file (
sell_marketing_v1_oas3.yaml
) to remove duplicateContent-Type
headers. Run thefix_openapi_schema_file
script to apply these changes and review the fixed file carefully. If the output is correct, update the original specification file accordingly.
sdk-ebay-rest-marketing
The Marketing API offers two platforms that sellers can use to promote and advertise their products:
- Promoted Listings is an eBay ad service that lets sellers set up ad campaigns for the products they want to promote. eBay displays the ads in search results and in other marketing modules as SPONSORED listings. If an item in a Promoted Listings campaign sells, the seller is assessed a Promoted Listings fee, which is a seller-specified percentage applied to the sales price. For complete details, refer to the Promoted Listings playbook.
- Promotions Manager gives sellers a way to offer discounts on specific items as a way to attract buyers to their inventory. Sellers can set up discounts (such as \"20% off\" and other types of offers) on specific items or on an entire customer order. To further attract buyers, eBay prominently displays promotion teasers throughout buyer flows. For complete details, see Promotions Manager.
Marketing reports, on both the Promoted Listings and Promotions Manager platforms, give sellers information that shows the effectiveness of their marketing strategies. The data gives sellers the ability to review and fine tune their marketing efforts.
Store Email Campaign allows sellers to create and send email campaigns to customers who have signed up to receive their newsletter. For more information on email campaigns, see Store Email Campaigns.
Important! Sellers must have an active eBay Store subscription, and they must accept the Terms and Conditions before they can make requests to these APIs in the Production environment. There are also site-specific listings requirements and restrictions associated with these marketing tools, as listed in the \"requirements and restrictions\" sections for Promoted Listings and Promotions Manager.
The table below lists all the Marketing API calls grouped by resource.
Installation & Usage
Requirements
PHP 7.4 and later. Should also work with PHP 8.0.
Composer
To install the bindings via Composer, add the following to composer.json
:
Then run composer install
Manual Installation
Download the files and include autoload.php
:
Getting Started
Please follow the installation procedure and then run the following:
API Endpoints
All URIs are relative to https://api.ebay.com/sell/marketing/v1
Class | Method | HTTP request | Description |
---|---|---|---|
AdApi | bulkCreateAdsByInventoryReference | POST /ad_campaign/{campaign_id}/bulk_create_ads_by_inventory_reference | |
AdApi | bulkCreateAdsByListingId | POST /ad_campaign/{campaign_id}/bulk_create_ads_by_listing_id | |
AdApi | bulkDeleteAdsByInventoryReference | POST /ad_campaign/{campaign_id}/bulk_delete_ads_by_inventory_reference | |
AdApi | bulkDeleteAdsByListingId | POST /ad_campaign/{campaign_id}/bulk_delete_ads_by_listing_id | |
AdApi | bulkUpdateAdsBidByInventoryReference | POST /ad_campaign/{campaign_id}/bulk_update_ads_bid_by_inventory_reference | |
AdApi | bulkUpdateAdsBidByListingId | POST /ad_campaign/{campaign_id}/bulk_update_ads_bid_by_listing_id | |
AdApi | bulkUpdateAdsStatus | POST /ad_campaign/{campaign_id}/bulk_update_ads_status | |
AdApi | bulkUpdateAdsStatusByListingId | POST /ad_campaign/{campaign_id}/bulk_update_ads_status_by_listing_id | |
AdApi | createAdByListingId | POST /ad_campaign/{campaign_id}/ad | |
AdApi | createAdsByInventoryReference | POST /ad_campaign/{campaign_id}/create_ads_by_inventory_reference | |
AdApi | deleteAd | DELETE /ad_campaign/{campaign_id}/ad/{ad_id} | |
AdApi | deleteAdsByInventoryReference | POST /ad_campaign/{campaign_id}/delete_ads_by_inventory_reference | |
AdApi | getAd | GET /ad_campaign/{campaign_id}/ad/{ad_id} | |
AdApi | getAds | GET /ad_campaign/{campaign_id}/ad | |
AdApi | getAdsByInventoryReference | GET /ad_campaign/{campaign_id}/get_ads_by_inventory_reference | |
AdApi | updateBid | POST /ad_campaign/{campaign_id}/ad/{ad_id}/update_bid | |
AdGroupApi | createAdGroup | POST /ad_campaign/{campaign_id}/ad_group | |
AdGroupApi | getAdGroup | GET /ad_campaign/{campaign_id}/ad_group/{ad_group_id} | |
AdGroupApi | getAdGroups | GET /ad_campaign/{campaign_id}/ad_group | |
AdGroupApi | suggestBids | POST /ad_campaign/{campaign_id}/ad_group/{ad_group_id}/suggest_bids | |
AdGroupApi | suggestKeywords | POST /ad_campaign/{campaign_id}/ad_group/{ad_group_id}/suggest_keywords | |
AdGroupApi | updateAdGroup | PUT /ad_campaign/{campaign_id}/ad_group/{ad_group_id} | |
AdReportApi | getReport | GET /ad_report/{report_id} | |
AdReportMetadataApi | getReportMetadata | GET /ad_report_metadata | |
AdReportMetadataApi | getReportMetadataForReportType | GET /ad_report_metadata/{report_type} | |
AdReportTaskApi | createReportTask | POST /ad_report_task | |
AdReportTaskApi | deleteReportTask | DELETE /ad_report_task/{report_task_id} | |
AdReportTaskApi | getReportTask | GET /ad_report_task/{report_task_id} | |
AdReportTaskApi | getReportTasks | GET /ad_report_task | |
CampaignApi | cloneCampaign | POST /ad_campaign/{campaign_id}/clone | |
CampaignApi | createCampaign | POST /ad_campaign | |
CampaignApi | deleteCampaign | DELETE /ad_campaign/{campaign_id} | |
CampaignApi | endCampaign | POST /ad_campaign/{campaign_id}/end | |
CampaignApi | findCampaignByAdReference | GET /ad_campaign/find_campaign_by_ad_reference | |
CampaignApi | getCampaign | GET /ad_campaign/{campaign_id} | |
CampaignApi | getCampaignByName | GET /ad_campaign/get_campaign_by_name | |
CampaignApi | getCampaigns | GET /ad_campaign | |
CampaignApi | launchCampaign | POST /ad_campaign/{campaign_id}/launch | |
CampaignApi | pauseCampaign | POST /ad_campaign/{campaign_id}/pause | |
CampaignApi | resumeCampaign | POST /ad_campaign/{campaign_id}/resume | |
CampaignApi | setupQuickCampaign | POST /ad_campaign/setup_quick_campaign | |
CampaignApi | suggestBudget | GET /ad_campaign/suggest_budget | |
CampaignApi | suggestItems | GET /ad_campaign/{campaign_id}/suggest_items | |
CampaignApi | suggestMaxCpc | POST /ad_campaign/suggest_max_cpc | |
CampaignApi | updateAdRateStrategy | POST /ad_campaign/{campaign_id}/update_ad_rate_strategy | |
CampaignApi | updateBiddingStrategy | POST /ad_campaign/{campaign_id}/update_bidding_strategy | |
CampaignApi | updateCampaignBudget | POST /ad_campaign/{campaign_id}/update_campaign_budget | |
CampaignApi | updateCampaignIdentification | POST /ad_campaign/{campaign_id}/update_campaign_identification | |
EmailCampaignApi | createEmailCampaign | POST /email_campaign | |
EmailCampaignApi | deleteEmailCampaign | DELETE /email_campaign/{email_campaign_id} | |
EmailCampaignApi | getAudiences | GET /email_campaign/audience | |
EmailCampaignApi | getEmailCampaign | GET /email_campaign/{email_campaign_id} | |
EmailCampaignApi | getEmailCampaigns | GET /email_campaign | |
EmailCampaignApi | getEmailPreview | GET /email_campaign/{email_campaign_id}/email_preview | |
EmailCampaignApi | getEmailReport | GET /email_campaign/report | |
EmailCampaignApi | updateEmailCampaign | PUT /email_campaign/{email_campaign_id} | |
ItemPriceMarkdownApi | createItemPriceMarkdownPromotion | POST /item_price_markdown | |
ItemPriceMarkdownApi | deleteItemPriceMarkdownPromotion | DELETE /item_price_markdown/{promotion_id} | |
ItemPriceMarkdownApi | getItemPriceMarkdownPromotion | GET /item_price_markdown/{promotion_id} | |
ItemPriceMarkdownApi | updateItemPriceMarkdownPromotion | PUT /item_price_markdown/{promotion_id} | |
ItemPromotionApi | createItemPromotion | POST /item_promotion | |
ItemPromotionApi | deleteItemPromotion | DELETE /item_promotion/{promotion_id} | |
ItemPromotionApi | getItemPromotion | GET /item_promotion/{promotion_id} | |
ItemPromotionApi | updateItemPromotion | PUT /item_promotion/{promotion_id} | |
KeywordApi | bulkCreateKeyword | POST /ad_campaign/{campaign_id}/bulk_create_keyword | |
KeywordApi | bulkUpdateKeyword | POST /ad_campaign/{campaign_id}/bulk_update_keyword | |
KeywordApi | createKeyword | POST /ad_campaign/{campaign_id}/keyword | |
KeywordApi | getKeyword | GET /ad_campaign/{campaign_id}/keyword/{keyword_id} | |
KeywordApi | getKeywords | GET /ad_campaign/{campaign_id}/keyword | |
KeywordApi | updateKeyword | PUT /ad_campaign/{campaign_id}/keyword/{keyword_id} | |
NegativeKeywordApi | bulkCreateNegativeKeyword | POST /bulk_create_negative_keyword | |
NegativeKeywordApi | bulkUpdateNegativeKeyword | POST /bulk_update_negative_keyword | |
NegativeKeywordApi | createNegativeKeyword | POST /negative_keyword | |
NegativeKeywordApi | getNegativeKeyword | GET /negative_keyword/{negative_keyword_id} | |
NegativeKeywordApi | getNegativeKeywords | GET /negative_keyword | |
NegativeKeywordApi | updateNegativeKeyword | PUT /negative_keyword/{negative_keyword_id} | |
PromotionApi | getListingSet | GET /promotion/{promotion_id}/get_listing_set | |
PromotionApi | getPromotions | GET /promotion | |
PromotionApi | pausePromotion | POST /promotion/{promotion_id}/pause | |
PromotionApi | resumePromotion | POST /promotion/{promotion_id}/resume | |
PromotionReportApi | getPromotionReports | GET /promotion_report | |
PromotionSummaryReportApi | getPromotionSummaryReport | GET /promotion_summary_report |
Models
- Ad
- AdGroup
- AdGroupPagedCollectionResponse
- AdIds
- AdPagedCollectionResponse
- AdReference
- AdReferences
- AdResponse
- AdUpdateResponse
- AdUpdateStatusByListingIdResponse
- AdUpdateStatusResponse
- AdditionalInfo
- AdditionalInfoData
- Ads
- Alert
- AlertDetails
- AlertDimension
- Amount
- Aspect
- BaseResponse
- BidPreference
- Budget
- BudgetRecommendationResponse
- BudgetRequest
- BulkAdResponse
- BulkAdUpdateResponse
- BulkAdUpdateStatusByListingIdResponse
- BulkAdUpdateStatusResponse
- BulkCreateAdRequest
- BulkCreateAdsByInventoryReferenceRequest
- BulkCreateAdsByInventoryReferenceResponse
- BulkCreateKeywordRequest
- BulkCreateKeywordResponse
- BulkCreateNegativeKeywordRequest
- BulkCreateNegativeKeywordResponse
- BulkDeleteAdRequest
- BulkDeleteAdResponse
- BulkDeleteAdsByInventoryReferenceRequest
- BulkDeleteAdsByInventoryReferenceResponse
- BulkUpdateAdStatusByListingIdRequest
- BulkUpdateAdStatusRequest
- BulkUpdateAdsByInventoryReferenceResponse
- BulkUpdateKeywordRequest
- BulkUpdateKeywordResponse
- BulkUpdateNegativeKeywordRequest
- BulkUpdateNegativeKeywordResponse
- Campaign
- CampaignAudience
- CampaignBudget
- CampaignBudgetRequest
- CampaignCriterion
- CampaignDTO
- CampaignPagedCollectionResponse
- Campaigns
- CloneCampaignRequest
- CouponConfiguration
- CreateAdGroupRequest
- CreateAdRequest
- CreateAdsByInventoryReferenceRequest
- CreateAdsByInventoryReferenceResponse
- CreateCampaignRequest
- CreateEmailCampaignRequest
- CreateEmailCampaignResponse
- CreateKeywordRequest
- CreateNegativeKeywordRequest
- CreateReportTask
- DeleteAdRequest
- DeleteAdResponse
- DeleteAdsByInventoryReferenceRequest
- DeleteAdsByInventoryReferenceResponse
- DeleteEmailCampaignResponse
- Dimension
- DimensionKeyAnnotation
- DimensionMetadata
- DiscountBenefit
- DiscountRule
- DiscountSpecification
- DynamicAdRatePreference
- Error
- ErrorParameter
- FundingStrategy
- GetEmailCampaignAudiencesResponse
- GetEmailCampaignResponse
- GetEmailCampaignsResponse
- GetEmailPreviewResponse
- GetEmailReportResponse
- InventoryCriterion
- InventoryItem
- InventoryReference
- ItemBasis
- ItemMarkdownStatus
- ItemPriceMarkdown
- ItemPromotion
- ItemPromotionResponse
- ItemsPagedCollection
- Keyword
- KeywordPagedCollectionResponse
- KeywordRequest
- KeywordResponse
- ListingDetail
- MaxCpc
- MetricMetadata
- NegativeKeyword
- NegativeKeywordPagedCollectionResponse
- NegativeKeywordResponse
- PriceRange
- PromotionDetail
- PromotionReportDetail
- PromotionsPagedCollection
- PromotionsReportPagedCollection
- ProposedBid
- QuickSetupRequest
- ReportMetadata
- ReportMetadatas
- ReportTask
- ReportTaskPagedCollection
- RuleCriteria
- SelectedInventoryDiscount
- SelectionRule
- SuggestBudgetResponse
- SuggestMaxCpcRequest
- SuggestMaxCpcResponse
- SuggestedBids
- SuggestedKeywords
- SummaryReportResponse
- TargetedAdsPagedCollection
- TargetedBidRequest
- TargetedBidsPagedCollection
- TargetedKeywordRequest
- TargetedKeywordsPagedCollection
- TargetingItems
- UpdateAdGroupRequest
- UpdateAdStatusByListingIdRequest
- UpdateAdStatusRequest
- UpdateAdrateStrategyRequest
- UpdateAdsByInventoryReferenceResponse
- UpdateBidPercentageRequest
- UpdateBiddingStrategyRequest
- UpdateCampaignBudgetRequest
- UpdateCampaignIdentificationRequest
- UpdateCampaignRequest
- UpdateEmailCampaignResponse
- UpdateKeywordByKeywordIdRequest
- UpdateKeywordRequest
- UpdateKeywordResponse
- UpdateNegativeKeywordIdRequest
- UpdateNegativeKeywordRequest
- UpdateNegativeKeywordResponse
Authorization
Authentication schemes defined for the API:
api_auth
- Type:
OAuth
- Flow:
application
- Authorization URL: ``
- Scopes:
- https://api.ebay.com/oauth/api_scope: View public data from eBay
api_auth
- Type:
OAuth
- Flow:
accessCode
- Authorization URL:
https://auth.ebay.com/oauth2/authorize
- Scopes:
- https://api.ebay.com/oauth/api_scope/sell.marketing.readonly: View your eBay marketing activities, such as ad campaigns and listing promotions
- https://api.ebay.com/oauth/api_scope/sell.marketing: View and manage your eBay marketing activities, such as ad campaigns and listing promotions
Tests
To run the tests, use:
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
v1.22.0
- Package version:
1.22.0
- Generator version:
7.11.0
- Package version:
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen
All versions of sdk-ebay-rest-marketing with dependencies
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0