src/Sell/Marketing/V1/Model/Ad.php
<?php
/**
* This file is part of the trollandtoad/ebay-sdk-php package.
*
* MIT License
*
* Copyright (c) 2022 Brandon Clothier
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*/
declare(strict_types=1);
/**
* Ad.
*
* PHP version ^7.2 || ^8.0
*
* @category Class
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*/
/**
* Marketing API.
*
* <p>The <i>Marketing API </i> offers two platforms that sellers can use to promote and advertise their products:</p> <ul><li><b>Promoted Listings</b> is an eBay ad service that lets sellers set up <i>ad campaigns </i> for the products they want to promote. eBay displays the ads in search results and in other marketing modules as <b>SPONSORED</b> 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 <a href=\"/api-docs/sell/static/marketing/pl-landing.html\">Promoted Listings playbook</a>.</li><li><b>Promotions Manager</b> 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 <i>teasers</i> throughout buyer flows. For complete details, see <a href=\"/api-docs/sell/static/marketing/promotions-manager.html\">Promotions Manager</a>.</li></ul> <p><b>Marketing reports</b>, 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.</p> <p class=\"tablenote\"><b>Important!</b> Sellers must have an active eBay Store subscription, and they must accept the <b>Terms and Conditions</b> 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 <a href=\"/api-docs/sell/marketing/static/overview.html#PL-requirements\">Promoted Listings</a> and <a href=\"/api-docs/sell/marketing/static/overview.html#PM-requirements\">Promotions Manager</a>.</p> <p>The table below lists all the Marketing API calls grouped by resource.</p>
*
* The version of the OpenAPI document: v1.14.0
* Generated by: https://openapi-generator.tech
* OpenAPI Generator version: 5.4.0
*/
/**
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
namespace TNT\Ebay\Sell\Marketing\V1\Model;
use TNT\Ebay\Sell\Marketing\V1\ObjectSerializer;
/**
* Ad Class Doc Comment.
*
* @category Class
*
* @description A type that defines the fields for an ad.
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*
* @implements \ArrayAccess<TKey, TValue>
*
* @template TKey int|null
* @template TValue mixed|null
*/
class Ad implements ModelInterface, \ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'Ad';
/**
* Array of property to type mappings. Used for (de)serialization.
*
* @var string[]
*/
protected static $openAPITypes = [
'ad_group_id' => 'string',
'ad_id' => 'string',
'ad_status' => 'string',
'alerts' => '\TNT\Ebay\Sell\Marketing\V1\Model\Alert[]',
'bid_percentage' => 'string',
'inventory_reference_id' => 'string',
'inventory_reference_type' => 'string',
'listing_id' => 'string',
];
/**
* Array of property to format mappings. Used for (de)serialization.
*
* @var string[]
*
* @phpstan-var array<string, string|null>
*
* @psalm-var array<string, string|null>
*/
protected static $openAPIFormats = [
'ad_group_id' => null,
'ad_id' => null,
'ad_status' => null,
'alerts' => null,
'bid_percentage' => null,
'inventory_reference_id' => null,
'inventory_reference_type' => null,
'listing_id' => null,
];
/**
* Array of property to type mappings. Used for (de)serialization.
*
* @return array
*/
public static function openAPITypes()
{
return self::$openAPITypes;
}
/**
* Array of property to format mappings. Used for (de)serialization.
*
* @return array
*/
public static function openAPIFormats()
{
return self::$openAPIFormats;
}
/**
* Array of attributes where the key is the local name,
* and the value is the original name.
*
* @var string[]
*/
protected static $attributeMap = [
'ad_group_id' => 'adGroupId',
'ad_id' => 'adId',
'ad_status' => 'adStatus',
'alerts' => 'alerts',
'bid_percentage' => 'bidPercentage',
'inventory_reference_id' => 'inventoryReferenceId',
'inventory_reference_type' => 'inventoryReferenceType',
'listing_id' => 'listingId',
];
/**
* Array of attributes to setter functions (for deserialization of responses).
*
* @var string[]
*/
protected static $setters = [
'ad_group_id' => 'setAdGroupId',
'ad_id' => 'setAdId',
'ad_status' => 'setAdStatus',
'alerts' => 'setAlerts',
'bid_percentage' => 'setBidPercentage',
'inventory_reference_id' => 'setInventoryReferenceId',
'inventory_reference_type' => 'setInventoryReferenceType',
'listing_id' => 'setListingId',
];
/**
* Array of attributes to getter functions (for serialization of requests).
*
* @var string[]
*/
protected static $getters = [
'ad_group_id' => 'getAdGroupId',
'ad_id' => 'getAdId',
'ad_status' => 'getAdStatus',
'alerts' => 'getAlerts',
'bid_percentage' => 'getBidPercentage',
'inventory_reference_id' => 'getInventoryReferenceId',
'inventory_reference_type' => 'getInventoryReferenceType',
'listing_id' => 'getListingId',
];
/**
* Array of attributes where the key is the local name,
* and the value is the original name.
*
* @return array
*/
public static function attributeMap()
{
return self::$attributeMap;
}
/**
* Array of attributes to setter functions (for deserialization of responses).
*
* @return array
*/
public static function setters()
{
return self::$setters;
}
/**
* Array of attributes to getter functions (for serialization of requests).
*
* @return array
*/
public static function getters()
{
return self::$getters;
}
/**
* The original name of the model.
*
* @return string
*/
public function getModelName()
{
return self::$openAPIModelName;
}
/**
* Associative array for storing property values.
*
* @var mixed[]
*/
protected $container = [];
/**
* Constructor.
*
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
{
$this->container['ad_group_id'] = $data['ad_group_id'] ?? null;
$this->container['ad_id'] = $data['ad_id'] ?? null;
$this->container['ad_status'] = $data['ad_status'] ?? null;
$this->container['alerts'] = $data['alerts'] ?? null;
$this->container['bid_percentage'] = $data['bid_percentage'] ?? null;
$this->container['inventory_reference_id'] = $data['inventory_reference_id'] ?? null;
$this->container['inventory_reference_type'] = $data['inventory_reference_type'] ?? null;
$this->container['listing_id'] = $data['listing_id'] ?? null;
}
/**
* Show all the invalid properties with reasons.
*
* @return array invalid properties with reasons
*/
public function listInvalidProperties()
{
$invalidProperties = [];
return $invalidProperties;
}
/**
* Validate all the properties in the model
* return true if all passed.
*
* @return bool True if all properties are valid
*/
public function valid()
{
return count($this->listInvalidProperties()) === 0;
}
/**
* Gets ad_group_id.
*
* @return string|null
*/
public function getAdGroupId()
{
return $this->container['ad_group_id'];
}
/**
* Sets ad_group_id.
*
* @param string|null $ad_group_id A unique eBay-assigned ID for an ad group in a campaign that uses the Cost Per Click (CPC) funding model. This ID is created after a successful <a href=\"/api-docs/sell/marketing/resources/adgroup/methods/createAdGroup\">createAdGroup</a> call, and all ad groups must be associated with a CPC campaign.
*
* @return self
*/
public function setAdGroupId($ad_group_id)
{
$this->container['ad_group_id'] = $ad_group_id;
return $this;
}
/**
* Gets ad_id.
*
* @return string|null
*/
public function getAdId()
{
return $this->container['ad_id'];
}
/**
* Sets ad_id.
*
* @param string|null $ad_id a unique eBay-assigned ID that is generated when the ad is created
*
* @return self
*/
public function setAdId($ad_id)
{
$this->container['ad_id'] = $ad_id;
return $this;
}
/**
* Gets ad_status.
*
* @return string|null
*/
public function getAdStatus()
{
return $this->container['ad_status'];
}
/**
* Sets ad_status.
*
* @param string|null $ad_status The current status of the CPC ad.<br /><br /><b>Valid Values:</b><ul><li><code>ACTIVE</code></li><li><code>PAUSED</code></li><li><code>ARCHIVED</code></li></ul><span class=\"tablenote\"><b>Note:</b> This type only applies to the Cost Per Click (CPC) funding model; it does not apply to the Cost Per Sale (CPS) funding model.</span> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/marketing/types/pls:AdStatusEnum'>eBay API documentation</a>
*
* @return self
*/
public function setAdStatus($ad_status)
{
$this->container['ad_status'] = $ad_status;
return $this;
}
/**
* Gets alerts.
*
* @return \TNT\Ebay\Sell\Marketing\V1\Model\Alert[]|null
*/
public function getAlerts()
{
return $this->container['alerts'];
}
/**
* Sets alerts.
*
* @param \TNT\Ebay\Sell\Marketing\V1\Model\Alert[]|null $alerts an array containing alert messages for the ad
*
* @return self
*/
public function setAlerts($alerts)
{
$this->container['alerts'] = $alerts;
return $this;
}
/**
* Gets bid_percentage.
*
* @return string|null
*/
public function getBidPercentage()
{
return $this->container['bid_percentage'];
}
/**
* Sets bid_percentage.
*
* @param string|null $bid_percentage The user-defined <b>bid percentage</b> (also known as the <i>ad rate</i>) sets the level that eBay increases the visibility in search results for the associated listing. The higher the <b>bidPercentage</b> value, the more eBay promotes the listing. <br><br>The value specified here is also used to calculate the Promoted Listings fee. This percentage value is multiplied by the final sales price to determine the fee. <br><br>The Promoted Listings fee is determined at the time the transaction completes and the seller is assessed the fee only when an item sells through a Promoted Listings ad campaign. <br><br>The <b>bidPercentage</b> is a single precision value that is guided by the following rules: <ul><li>These values are <b>valid</b>:<br> <code>4.1</code>, <code>5.0</code>, <code>5.5</code>, ...</li> <li>These values are <b>not valid</b>:<br /> <code>0.01</code>, <code>10.75</code>, <code>99.99</code>,<br /> and so on.</li></ul>This is default bid percentage for the campaigns using the Cost Per Sale (CPS) funding model, and this value will be overridden by any ads in the campaign that have their own set bid percentages.<br /><br />If a bid percentage is not provided for an ad, eBay uses the default bid percentage of the associated campaign.<br /><br /><span class=\"tablenote\"><b>Note:</b>This field will always be returned for campaigns that use the Cost Per Sale (CPS) funding model. It will not be returned for campaigns that use the Cost Per Click (CPC) funding model.</span><br /><b>Minimum value:</b> 2.0 <br><b>Maximum value:</b> 100.0
*
* @return self
*/
public function setBidPercentage($bid_percentage)
{
$this->container['bid_percentage'] = $bid_percentage;
return $this;
}
/**
* Gets inventory_reference_id.
*
* @return string|null
*/
public function getInventoryReferenceId()
{
return $this->container['inventory_reference_id'];
}
/**
* Sets inventory_reference_id.
*
* @param string|null $inventory_reference_id An ID that identifies a single-item listing or multiple-variation listing that is managed with the <a href=\"/api-docs/sell/inventory/resources/methods\" title=\"Inventory API Reference\">Inventory API</a>. <p>The <i>inventory reference ID</i> is a seller-defined value that can be either an <b>SKU</b> for a single-item listing or an <b>inventoryItemGroupKey</b> for a multiple-value listing.</p> <p>An <i>inventoryItemGroupKey</i> is a value that the seller defines to indicate a listing that's the parent of an inventory item group (a multiple-variation listing, such as a listing for a shirt that's available in multiple sizes and colors).</p><p>This field is only returned if the ad is associated with a SKU or an inventory item group value.</p>
*
* @return self
*/
public function setInventoryReferenceId($inventory_reference_id)
{
$this->container['inventory_reference_id'] = $inventory_reference_id;
return $this;
}
/**
* Gets inventory_reference_type.
*
* @return string|null
*/
public function getInventoryReferenceType()
{
return $this->container['inventory_reference_type'];
}
/**
* Sets inventory_reference_type.
*
* @param string|null $inventory_reference_type The enumeration value returned here indicates the type of listing the inventoryReferenceId references. The value returned here will be <code>INVENTORY_ITEM</code> for a single-variation listing, or <code>INVENTORY_ITEM_GROUP</code> for a multiple-variation listing. <p>This field is only returned if the ad is associated with a SKU or an inventory item group value.</p> For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/marketing/types/pls:InventoryReferenceTypeEnum'>eBay API documentation</a>
*
* @return self
*/
public function setInventoryReferenceType($inventory_reference_type)
{
$this->container['inventory_reference_type'] = $inventory_reference_type;
return $this;
}
/**
* Gets listing_id.
*
* @return string|null
*/
public function getListingId()
{
return $this->container['listing_id'];
}
/**
* Sets listing_id.
*
* @param string|null $listing_id a unique eBay-assigned ID that is generated when a listing is created
*
* @return self
*/
public function setListingId($listing_id)
{
$this->container['listing_id'] = $listing_id;
return $this;
}
/**
* Returns true if offset exists. False otherwise.
*
* @param int $offset Offset
*/
public function offsetExists($offset): bool
{
return isset($this->container[$offset]);
}
/**
* Gets offset.
*
* @param int $offset Offset
*
* @return mixed|null
*/
#[\ReturnTypeWillChange]
public function offsetGet($offset)
{
return $this->container[$offset] ?? null;
}
/**
* Sets value based on offset.
*
* @param int|null $offset Offset
* @param mixed $value Value to be set
*/
public function offsetSet($offset, $value): void
{
if (null === $offset) {
$this->container[] = $value;
} else {
$this->container[$offset] = $value;
}
}
/**
* Unsets offset.
*
* @param int $offset Offset
*/
public function offsetUnset($offset): void
{
unset($this->container[$offset]);
}
/**
* Serializes the object to a value that can be serialized natively by json_encode().
*
* @see https://www.php.net/manual/en/jsonserializable.jsonserialize.php
*
* @return mixed returns data which can be serialized by json_encode(), which is a value
* of any type other than a resource
*/
#[\ReturnTypeWillChange]
public function jsonSerialize()
{
return ObjectSerializer::sanitizeForSerialization($this);
}
/**
* Gets the string presentation of the object.
*
* @return string
*/
public function __toString()
{
return json_encode(
ObjectSerializer::sanitizeForSerialization($this),
JSON_PRETTY_PRINT
);
}
/**
* Gets a header-safe presentation of the object.
*
* @return string
*/
public function toHeaderValue()
{
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}