Name | Type | Description | Notes |
---|---|---|---|
budget | \macropage\SDKs\ebay\rest\marketing\Model\CampaignBudgetRequest | [optional] | |
campaignCriterion | \macropage\SDKs\ebay\rest\marketing\Model\CampaignCriterion | [optional] | |
campaignName | string | A seller-defined name for the campaign. This value must be unique for the seller. <p>You can use any alphanumeric characters in the name, except the less than (<) or greater than (>) characters.</p><b>Max length:</b> 80 characters | [optional] |
campaignTargetingType | string | The targeting type of the campaign. This value indicates whether the campaign is a manual targeting or smart targeting campaign.<br><br>If not value is specified, this field will default to <code>MANUAL</code>.<br><br><span class="tablenote"><b>Note:</b> This feature is only supported for on-site campaigns that use the Cost Per Click (CPC) funding model.</span><br><b>Valid Values:</b><ul><li><code>MANUAL</code></li><li><code>SMART</code></li></ul>This field is required and must be set to </code>SMART</code> for a Smart Targeting campaign. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/marketing/types/pls:CampaignTargetingTypeEnum'>eBay API documentation</a> | [optional] |
channels | string[] | The channel for the campaign. This value indicates whether the advertising campaign is an Onsite or Offsite.<br><br>If no value is entered, this field will default to <code>ON_SITE</code>. Multiple channels are not supported. <br><br><span class="tablenote"><b>Note:</b> <b>Channels</b> is only applicable for campaigns that use the Cost Per Click (CPC) funding model.</span><br><b>Valid Values:</b><ul><li><code>ON_SITE</code></li><li><code>OFF_SITE</code></li></ul>This field is required and must be set to <code>OFF_SITE</code> for an Offsite Ads campaign. | [optional] |
endDate | string | The date and time the campaign ends, in UTC format (<code>yyyy-MM-ddThh:mm:ssZ</code>). If this field is omitted, the campaign will have no defined end date, and will not end until the seller makes a decision to end the campaign with an <a href="/api-docs/sell/marketing/resources/campaign/methods/endCampaign">endCampaign</a> call, or if they update the campaign at a later time with an end date. | [optional] |
fundingStrategy | \macropage\SDKs\ebay\rest\marketing\Model\FundingStrategy | [optional] | |
marketplaceId | string | The ID of the eBay marketplace where the campaign is hosted. See the <b>MarketplaceIdEnum</b> type to get the appropriate enumeration value for the listing marketplace. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/marketing/types/ba:MarketplaceIdEnum'>eBay API documentation</a> | [optional] |
startDate | string | The date and time the campaign starts, in UTC format (<code>yyyy-MM-ddThh:mm:ssZ</code>). For display purposes, convert this time into the local time of the seller. <p>On the date specified, the service derives the keywords for each listing in the campaign, creates an ad for each listing, and associates each new ad with the campaign. The campaign starts after this process is completed. The amount of time it takes the service to start the campaign depends on the number of listings in the campaign. Call <b>getCampaign</b> to check the status of the campaign.</p> | [optional] |