src/Sell/Marketing/V1/Model/CreateReportTask.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);
/**
* CreateReportTask.
*
* 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;
/**
* CreateReportTask Class Doc Comment.
*
* @category Class
*
* @description This type defines the rules that govern the generation of a report task and the criteria that's used to create the report. The report-generation rules include the starting and ending dates for the report. Report-task criteria includes the report dimensions, metrics, listings covered in the report, and so on. For information on the required and optional fields for each report type, see <a href=\"/api-docs/sell/static/marketing/pl-reports.html\">Promoted Listings reporting</a>.
*
* @author OpenAPI Generator team
*
* @see https://openapi-generator.tech
*
* @implements \ArrayAccess<TKey, TValue>
*
* @template TKey int|null
* @template TValue mixed|null
*/
class CreateReportTask implements ModelInterface, \ArrayAccess, \JsonSerializable
{
public const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $openAPIModelName = 'CreateReportTask';
/**
* Array of property to type mappings. Used for (de)serialization.
*
* @var string[]
*/
protected static $openAPITypes = [
'additional_records' => 'string[]',
'campaign_ids' => 'string[]',
'date_from' => 'string',
'date_to' => 'string',
'dimensions' => '\TNT\Ebay\Sell\Marketing\V1\Model\Dimension[]',
'funding_models' => 'string[]',
'inventory_references' => '\TNT\Ebay\Sell\Marketing\V1\Model\InventoryReference[]',
'listing_ids' => 'string[]',
'marketplace_id' => 'string',
'metric_keys' => 'string[]',
'report_format' => 'string',
'report_type' => '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 = [
'additional_records' => null,
'campaign_ids' => null,
'date_from' => null,
'date_to' => null,
'dimensions' => null,
'funding_models' => null,
'inventory_references' => null,
'listing_ids' => null,
'marketplace_id' => null,
'metric_keys' => null,
'report_format' => null,
'report_type' => 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 = [
'additional_records' => 'additionalRecords',
'campaign_ids' => 'campaignIds',
'date_from' => 'dateFrom',
'date_to' => 'dateTo',
'dimensions' => 'dimensions',
'funding_models' => 'fundingModels',
'inventory_references' => 'inventoryReferences',
'listing_ids' => 'listingIds',
'marketplace_id' => 'marketplaceId',
'metric_keys' => 'metricKeys',
'report_format' => 'reportFormat',
'report_type' => 'reportType',
];
/**
* Array of attributes to setter functions (for deserialization of responses).
*
* @var string[]
*/
protected static $setters = [
'additional_records' => 'setAdditionalRecords',
'campaign_ids' => 'setCampaignIds',
'date_from' => 'setDateFrom',
'date_to' => 'setDateTo',
'dimensions' => 'setDimensions',
'funding_models' => 'setFundingModels',
'inventory_references' => 'setInventoryReferences',
'listing_ids' => 'setListingIds',
'marketplace_id' => 'setMarketplaceId',
'metric_keys' => 'setMetricKeys',
'report_format' => 'setReportFormat',
'report_type' => 'setReportType',
];
/**
* Array of attributes to getter functions (for serialization of requests).
*
* @var string[]
*/
protected static $getters = [
'additional_records' => 'getAdditionalRecords',
'campaign_ids' => 'getCampaignIds',
'date_from' => 'getDateFrom',
'date_to' => 'getDateTo',
'dimensions' => 'getDimensions',
'funding_models' => 'getFundingModels',
'inventory_references' => 'getInventoryReferences',
'listing_ids' => 'getListingIds',
'marketplace_id' => 'getMarketplaceId',
'metric_keys' => 'getMetricKeys',
'report_format' => 'getReportFormat',
'report_type' => 'getReportType',
];
/**
* 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['additional_records'] = $data['additional_records'] ?? null;
$this->container['campaign_ids'] = $data['campaign_ids'] ?? null;
$this->container['date_from'] = $data['date_from'] ?? null;
$this->container['date_to'] = $data['date_to'] ?? null;
$this->container['dimensions'] = $data['dimensions'] ?? null;
$this->container['funding_models'] = $data['funding_models'] ?? null;
$this->container['inventory_references'] = $data['inventory_references'] ?? null;
$this->container['listing_ids'] = $data['listing_ids'] ?? null;
$this->container['marketplace_id'] = $data['marketplace_id'] ?? null;
$this->container['metric_keys'] = $data['metric_keys'] ?? null;
$this->container['report_format'] = $data['report_format'] ?? null;
$this->container['report_type'] = $data['report_type'] ?? 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 additional_records.
*
* @return string[]|null
*/
public function getAdditionalRecords()
{
return $this->container['additional_records'];
}
/**
* Sets additional_records.
*
* @param string[]|null $additional_records A list of additional records that shall be included in the report, such as non-performing data.<br /><br /><span class=\"tablenote\"><span style=\"color:#004680\"><strong>Note:</strong></span> Additional records are only applicable to Promoted Listings Advanced (PLA) campaigns that use the Cost Per Click (CPC) funding model.</span><br /><b>Valid Value:</b> <code>NON_PERFORMING_DATA</code>
*
* @return self
*/
public function setAdditionalRecords($additional_records)
{
$this->container['additional_records'] = $additional_records;
return $this;
}
/**
* Gets campaign_ids.
*
* @return string[]|null
*/
public function getCampaignIds()
{
return $this->container['campaign_ids'];
}
/**
* Sets campaign_ids.
*
* @param string[]|null $campaign_ids A list of campaign IDs to be included in the report task. Call <b>getCampaigns</b> to get a list of the current campaign IDs for a seller.<br /><br />For Promoted Listings Standard (PLS) sellers, this field is required if the <b>reportType</b> is set to <code>CAMPAIGN_PERFORMANCE_REPORT</code> or <code>CAMPAIGN_PERFORMANCE_SUMMARY_REPORT</code>.<br /><br />For Promoted Listings Advanced (PLA) sellers, leave this request field blank to retrieve the details for all campaigns associated with your account, or specify the campaign IDs for which you would like to retrieve the campaign-specific details.<br /><br /><span class=\"tablenote\"><span style=\"color:#004680\"><strong>Note:</strong></span> There is a maximum data limit that cannot be exceeded when generating reports. If this threshold is exceeded, the report will fail. Refer to <a href=\"/api-docs/sell/static/marketing/pl-reports.html#creation\">Promoted Listings reporting</a> in the Selling Integration Guide for details.</span><br /><br /><b>Maximum:</b><ul><li>25 IDs for PLS</li><li>1,000 IDs for PLA</li></ul>
*
* @return self
*/
public function setCampaignIds($campaign_ids)
{
$this->container['campaign_ids'] = $campaign_ids;
return $this;
}
/**
* Gets date_from.
*
* @return string|null
*/
public function getDateFrom()
{
return $this->container['date_from'];
}
/**
* Sets date_from.
*
* @param string|null $date_from The date defining the start of the timespan covered by the report.<br /><br />Format the timestamp as an <a href=\"https://www.iso.org/iso-8601-date-and-time-format.html\" title=\"https://www.iso.org\" target=\"_blank\">ISO 8601</a> string, which is based on the 24-hour Coordinated Universal Time (UTC) clock with local offset.<br /><br /><span class=\"tablenote\"><span style=\"color:#004680\"><strong>Note:</strong></span> The date specified cannot be a future date.</span><br /><br /><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code><br /><br /><b>Example:</b> <code>2021-03-15T13:00:00-07:00</code>
*
* @return self
*/
public function setDateFrom($date_from)
{
$this->container['date_from'] = $date_from;
return $this;
}
/**
* Gets date_to.
*
* @return string|null
*/
public function getDateTo()
{
return $this->container['date_to'];
}
/**
* Sets date_to.
*
* @param string|null $date_to The date defining the end of the timespan covered by the report.<br /><br />As with the <b>dateFrom</b> field, format the timestamp as an <a href=\"https://www.iso.org/iso-8601-date-and-time-format.html\" title=\"https://www.iso.org\" target=\"_blank\">ISO 8601</a> string.<br /><br /><span class=\"tablenote\"><span style=\"color:#004680\"><strong>Note:</strong></span> The date specified cannot be a future date. Additionally, the time specified must be a later time than that specified in the <b>dateFrom</b> field.</span><br /><br /><b>Format:</b> <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code><br /><br /><b>Example:</b> <code>2021-03-17T13:00:00-07:00</code>
*
* @return self
*/
public function setDateTo($date_to)
{
$this->container['date_to'] = $date_to;
return $this;
}
/**
* Gets dimensions.
*
* @return \TNT\Ebay\Sell\Marketing\V1\Model\Dimension[]|null
*/
public function getDimensions()
{
return $this->container['dimensions'];
}
/**
* Sets dimensions.
*
* @param \TNT\Ebay\Sell\Marketing\V1\Model\Dimension[]|null $dimensions The list of the dimensions applied to the report. <p>A dimension is an attribute to which the report data applies. For example, if you set <b>dimensionKey</b> to <code>campaign_id</code> in a Campaign Performance Report, the data will apply to the entire ad campaign. For information on the dimensions and how to specify them, see <a href=\"/api-docs/sell/static/marketing/pl-reports.html\">Promoted Listings reporting</a>.</p>
*
* @return self
*/
public function setDimensions($dimensions)
{
$this->container['dimensions'] = $dimensions;
return $this;
}
/**
* Gets funding_models.
*
* @return string[]|null
*/
public function getFundingModels()
{
return $this->container['funding_models'];
}
/**
* Sets funding_models.
*
* @param string[]|null $funding_models The funding model for the campaign that shall be included in the report.<br /><br /><span class=\"tablenote\"><span style=\"color:#004680\"><strong>Note:</strong></span> The default funding model for Promoted Listings reports is <code>COST_PER_SALE</code>.</span><br /><br /><span class=\"tablenote\"><span style=\"color:#004680\"><strong>Note:</strong></span> Multiple value support for the <b>fundingModels</b> array has been deprecated. See <a href =\"/develop/apis/api-deprecation-status \">API Deprecation Status</a> for information.</span><br /><br /><b>Valid Values:</b><ul><li><code>COST_PER_SALE</code></li><li><code>COST_PER_CLICK</code></li></ul><i>Required if</i> the campaign funding model is Cost Per Click (CPC).
*
* @return self
*/
public function setFundingModels($funding_models)
{
$this->container['funding_models'] = $funding_models;
return $this;
}
/**
* Gets inventory_references.
*
* @return \TNT\Ebay\Sell\Marketing\V1\Model\InventoryReference[]|null
*/
public function getInventoryReferences()
{
return $this->container['inventory_references'];
}
/**
* Sets inventory_references.
*
* @param \TNT\Ebay\Sell\Marketing\V1\Model\InventoryReference[]|null $inventory_references You can use this field to supply an array of items to include in the report if you manage your inventory with the <a href=\"/api-docs/sell/inventory/resources/methods\">Inventory API</a>. <br><br>This field is mutually exclusive with the <b>listingIds</b> field; if you populate this field, <i>do not</i> populate the <b>listingIds</b> field. <br><br>An inventory reference identifies an item in your inventory using a pair of values, where the <b>inventoryReferenceId</b> can be either a seller-defined <b>SKU</b> value or an <b>inventoryItemGroupKey</b>, where an <b>inventoryItemGroupKey</b> is seller-defined ID for an inventory item group (a multiple-variation listing). <br><br>Couple the <b>inventoryReferenceId</b> with an <b>inventoryReferenceType</b> identifier to fully identify an item in your inventory. <br><br><b>Maximum: </b> 500 items <br><br><i>Required if </i> you do not supply an array of <b>listingId</b> values or if you set <b>reportType</b> to <code>INVENTORY_PERFORMANCE_REPORT</code>.
*
* @return self
*/
public function setInventoryReferences($inventory_references)
{
$this->container['inventory_references'] = $inventory_references;
return $this;
}
/**
* Gets listing_ids.
*
* @return string[]|null
*/
public function getListingIds()
{
return $this->container['listing_ids'];
}
/**
* Sets listing_ids.
*
* @param string[]|null $listing_ids Use this field to supply an array of listing IDs you want to include in the report.<br><br>A listing ID is the eBay listing identifier that is generated when the listing is created. This field accepts listing ID values generated with both the Inventory API and the eBay Traditional APIs, such as the Trading and Finding APIs.<br><br><span class=\"tablenote\"><span style=\"color:#FF0000\"><strong>Important:</strong></span> This field is mutually exclusive with the <b>inventoryReferences</b> field; if you populate this field, <i>do not</i> populate the <b>inventoryReferences</b> field.</span><br /><br />For Promoted Listings Standard (PLS) sellers, this field is required if you do not supply an array of <b>inventoryReferences</b> values or if you set the <b>reportType</b> to <code>LISTING_PERFORMANCE_REPORT</code>.<br /><br />For Promoted Listings Advanced (PLA) sellers, leave this field blank to retrieve the details for all listings associated with the specified campaign IDs (or all campaigns associated with your account, if no campaign IDs are specified), or specify the listing IDs for which you would like to retrieve the listing-specific details.<br /><br /><span class=\"tablenote\"><span style=\"color:#004680\"><strong>Note:</strong></span> There is a maximum data limit that cannot be exceeded when generating reports. If this threshold is exceeded, the report will fail. Refer to <a href=\"/api-docs/sell/static/marketing/pl-reports.html#creation\">Promoted Listings reporting</a> in the Selling Integration Guide for details.</span><br /><br /><b>Maximum:</b> 500 listings
*
* @return self
*/
public function setListingIds($listing_ids)
{
$this->container['listing_ids'] = $listing_ids;
return $this;
}
/**
* Gets marketplace_id.
*
* @return string|null
*/
public function getMarketplaceId()
{
return $this->container['marketplace_id'];
}
/**
* Sets marketplace_id.
*
* @param string|null $marketplace_id The ID for the eBay marketplace on which the report is based.<br /><br /><b>Maximum: </b> 1 For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/marketing/types/ba:MarketplaceIdEnum'>eBay API documentation</a>
*
* @return self
*/
public function setMarketplaceId($marketplace_id)
{
$this->container['marketplace_id'] = $marketplace_id;
return $this;
}
/**
* Gets metric_keys.
*
* @return string[]|null
*/
public function getMetricKeys()
{
return $this->container['metric_keys'];
}
/**
* Sets metric_keys.
*
* @param string[]|null $metric_keys The list of metrics to be included in the report. <p>Metrics are the quantitative measurements compiled into the report and the data returned is based on the specified dimension of the report. For example, if the dimension is <code>campaign</code>, the metrics for <b>number of sales</b> would be the number of sales in the campaign. However, if the dimension is <code>listing</code>, the <b>number of sales</b> represents the number of items sold in that listing.</p> <p>For information on metric keys and how to set them, see <a href=\"/api-docs/sell/static/marketing/pl-reports.html\">Promoted Listings reporting</a>.</p><b>Minimum: </b> 1
*
* @return self
*/
public function setMetricKeys($metric_keys)
{
$this->container['metric_keys'] = $metric_keys;
return $this;
}
/**
* Gets report_format.
*
* @return string|null
*/
public function getReportFormat()
{
return $this->container['report_format'];
}
/**
* Sets report_format.
*
* @param string|null $report_format The file format of the report. Currently, the only supported format is <code>TSV_GZIP</code>, which is a gzip file with tab separated values. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/marketing/types/plr:ReportFormatEnum'>eBay API documentation</a>
*
* @return self
*/
public function setReportFormat($report_format)
{
$this->container['report_format'] = $report_format;
return $this;
}
/**
* Gets report_type.
*
* @return string|null
*/
public function getReportType()
{
return $this->container['report_type'];
}
/**
* Sets report_type.
*
* @param string|null $report_type The type of report to be generated, such as <code>ACCOUNT_PERFORMANCE_REPORT</code> or <code>CAMPAIGN_PERFORMANCE_REPORT</code>.<br/><br/><span class=\"tablenote\"><b>Note:</b> INVENTORY_PERFORMANCE_REPORT is not currently available; availability date is pending.</span><br /><br /><b>Maximum:</b> 1 For implementation help, refer to <a href='https://developer.ebay.com/api-docs/sell/marketing/types/plr:ReportTypeEnum'>eBay API documentation</a>
*
* @return self
*/
public function setReportType($report_type)
{
$this->container['report_type'] = $report_type;
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));
}
}