zvps / ebay-sell-marketing-php-client
营销API提供两个平台,卖家可以使用这些平台推广和宣传他们的产品:推广列表是eBay的一种广告服务,允许卖家为他们想要推广的产品设置广告活动。eBay将在搜索结果和其他营销模块中显示这些广告,作为赞助商列表。如果推广列表活动中的商品售出,卖家将按销售价格收取推广列表费用,该费用为卖家指定的百分比。有关详细信息,请参阅推广列表。促销管理器为卖家提供了一种方式,可以通过提供折扣来吸引买家浏览他们的库存。卖家可以在特定商品或整个客户订单上设置折扣(如“20%折扣”和其他类型的优惠)。为了进一步吸引买家,eBay在买家流程中突出显示了促销预告。有关详细信息,请参阅促销管理器。营销报告,在推广列表和促销管理器平台上,为卖家提供有关其营销策略有效性的信息。这些数据使卖家能够审查和微调他们的营销工作。重要提示!卖家必须有一个有效的eBay商店订阅,并且在生产环境中对这些API发出请求之前,他们必须接受条款和条件。此外,这些营销工具还与特定网站的相关列表要求及限制相关,具体请参阅推广列表和促销管理器的“要求和限制”部分。下表列出了所有按资源分组的营销API调用。
Requires
- php: >=5.6
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^6.2
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.12
- phpunit/phpunit: ^8.0 || ^9.0
This package is auto-updated.
Last update: 2024-09-29 06:20:19 UTC
README
营销API为卖家提供了两个平台,他们可以使用这些平台来推广和宣传他们的产品:推广列表是eBay的一项广告服务,允许卖家为想要推广的产品设置广告活动。eBay将在搜索结果和其他营销模块中以赞助商的形式展示这些广告。如果推广列表活动中的商品售出,卖家将按销售价格收取推广列表费用,该费用为卖家指定的百分比。有关详细信息,请参阅推广列表。促销管理器为卖家提供了一种提供特定商品折扣的方式,以吸引买家浏览他们的库存。卖家可以在特定商品或整个客户订单上设置折扣(例如“20%折扣”和其他类型的优惠)。为了进一步吸引买家,eBay在买家流程中突出显示了促销预告。有关详细信息,请参阅促销管理器。在推广列表和促销管理器平台上,营销报告为卖家提供了有关其营销策略有效性的信息。这些数据使卖家能够审查和微调他们的营销工作。重要提示!卖家必须有一个有效的eBay商店订阅,并且在使用生产环境中的这些API之前,他们必须接受条款和条件。此外,这些营销工具还与特定网站的相关列表要求及限制相关,具体请参阅推广列表和促销管理器的“要求和限制”部分。下表列出了所有按资源分组的营销API调用。
安装和用法
要求
PHP 7.2及更高版本。
Composer
要使用Composer安装绑定,请将以下内容添加到composer.json
{
"repositories": [
{
"type": "vcs",
"url": "https://github/zvps/ebay-sell-marketing-php-client.git"
}
],
"require": {
"zvps/ebay-sell-marketing-php-client": "*@dev"
}
}
然后运行composer install
手动安装
下载文件并包含autoload.php
<?php require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
入门
请遵循安装过程,然后运行以下命令
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure OAuth2 access token for authorization: Authorization Code $config = Ebay\Sell\Marketing\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); $apiInstance = new Ebay\Sell\Marketing\Api\AdApi( // 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 = 'campaign_id_example'; // string | A unique eBay-assigned ID for an ad campaign that's generated when a campaign is created. Get a seller's campaign IDs by calling getCampaigns. $body = new \Ebay\Sell\Marketing\Model\BulkCreateAdsByInventoryReferenceRequest(); // \Ebay\Sell\Marketing\Model\BulkCreateAdsByInventoryReferenceRequest | The container for the bulk request to create ads for eBay inventory reference IDs. eBay inventory reference IDs are seller-defined IDs used by theInventory API. try { $result = $apiInstance->bulkCreateAdsByInventoryReference($campaign_id, $body); print_r($result); } catch (Exception $e) { echo 'Exception when calling AdApi->bulkCreateAdsByInventoryReference: ', $e->getMessage(), PHP_EOL; }
API端点
所有URI都是相对于https://api.ebay.com/sell/marketing/v1
模型
- 广告
- AdIds
- AdPagedCollection
- AdReference
- AdReferences
- AdResponse
- Ads
- Amount
- BaseResponse
- BulkAdResponse
- BulkCreateAdRequest
- BulkCreateAdsByInventoryReferenceRequest
- BulkCreateAdsByInventoryReferenceResponse
- BulkDeleteAdRequest
- BulkDeleteAdResponse
- BulkDeleteAdsByInventoryReferenceRequest
- BulkDeleteAdsByInventoryReferenceResponse
- Campaign
- CampaignCriterion
- CampaignPagedCollection
- Campaigns
- CloneCampaignRequest
- CouponConfiguration
- CreateAdRequest
- CreateAdsByInventoryReferenceRequest
- CreateAdsByInventoryReferenceResponse
- CreateCampaignRequest
- CreateReportTask
- DeleteAdRequest
- DeleteAdResponse
- DeleteAdsByInventoryReferenceRequest
- DeleteAdsByInventoryReferenceResponse
- Dimension
- DimensionKeyAnnotation
- DimensionMetadata
- DiscountBenefit
- DiscountRule
- DiscountSpecification
- Error
- 错误参数
- 资金策略
- 库存标准
- 库存项目
- 库存参考
- 项目折扣
- 项目促销
- 项目促销响应
- 指标元数据
- 促销详情
- 促销报告详情
- 促销分页集合
- 促销报告分页集合
- 报告元数据
- 报告元数据集
- 报告任务
- 报告任务分页集合
- 规则标准
- 所选库存折扣
- 选择规则
- 摘要报告响应
- 更新出价百分比请求
- 更新活动标识请求
授权
授权代码
- 类型:
OAuth - 流程:
accessCode - 授权URL:
https://auth.ebay.com/oauth2/authorize - 作用域:
- https://api.ebay.com/oauth/api_scope/sell.marketing.readonly: 查看您的eBay营销活动,例如广告活动和列表促销
- https://api.ebay.com/oauth/api_scope/sell.marketing: 查看和管理您的eBay营销活动,例如广告活动和列表促销
客户端凭证
- 类型:
OAuth - 流程:
application - 授权URL: ``
- 作用域:
- https://api.ebay.com/oauth/api_scope: 查看来自eBay的公共数据
测试
要运行测试,请使用
composer install vendor/bin/phpunit
作者
关于此包
此PHP包是由OpenAPI Generator项目自动生成的
- API版本:
v1.10.0- 包版本:
5.0.0
- 包版本:
- 构建包:
org.openapitools.codegen.languages.PhpClientCodegen