README

Important Notice

Before using this SDK, you must modify the OpenAPI specification file (sell_marketing_v1_oas3.yaml) to remove duplicate Content-Type headers. Run the fix_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:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/macropage/sdk-ebay-rest-marketing.git"
    }
  ],
  "require": {
    "macropage/sdk-ebay-rest-marketing": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/sdk-ebay-rest-marketing/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure OAuth2 access token for authorization: api_auth
$config = macropage\SDKs\ebay\rest\marketing\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new macropage\SDKs\ebay\rest\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
);
$campaignId = 'campaignId_example'; // string | This path parameter specifies the unique eBay-assigned identifier of the ad campaign for which to associated the ads being created.<br><br> Use the <a href=\"/api-docs/sell/marketing/resources/campaign/methods/getCampaigns\" target=\"_blank\">getCampaigns</a> method to retrieve campaign IDs.
$bulkCreateAdsByInventoryReferenceRequest = new \macropage\SDKs\ebay\rest\marketing\Model\BulkCreateAdsByInventoryReferenceRequest(); // \macropage\SDKs\ebay\rest\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($campaignId, $bulkCreateAdsByInventoryReferenceRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdApi->bulkCreateAdsByInventoryReference: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.ebay.com/sell/marketing/v1

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:

composer install
vendor/bin/phpunit

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
• Build package: org.openapitools.codegen.languages.PhpClientCodegen