Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 3.79 KB

AdReportApi.md

File metadata and controls

71 lines (46 loc) · 3.79 KB
Raw

macropage\SDKs\ebay\rest\marketing\AdReportApi

All URIs are relative to https://api.ebay.com/sell/marketing/v1, except if the operation defines another base path.

Method HTTP request Description
getReport() GET /ad_report/{report_id}

getReport()

getReport($reportId): object

This call downloads the report as specified by the report_id path parameter.

Call <a href="/api-docs/sell/marketing/resources/ad_report_task/methods/createReportTask" title="createReportTask API docs">createReportTask to schedule and generate a Promoted Listings report. All date values are returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ).

<span class="tablenote">Note: The reporting of some data related to sales and ad-fees may require a 72-hour (maximum) adjustment period which is often referred to as the Reconciliation Period. Such adjustment periods should, on average, be minimal. However, at any given time, the payments tab may be used to view those amounts that have actually been charged.
<div class="msgbox_important"><p class="msgbox_importantInDiv" data-mc-autonum="<b><span style="color: #dd1e31;" class="mcFormatColor">Important! </span></b>"><span class="autonumber"><span style="color: #dd1e31;" class="mcFormatColor">Important!For ad_report and ad_report_task methods, the API call limit is subject to a per user quota. These API calls can only be executed a maximum of 200 times per hour for each seller/user. If the number of calls per hour exceeds this limit, any new calls will be blocked for the next hour.

Example

<?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');

// 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\AdReportApi(
    // 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
);
$reportId = 'reportId_example'; // string | This path parameter specifies the unique ID of the Promoted Listings report being retrieved.<br><br>Use the <a href=\"/api-docs/sell/marketing/resources/ad_report_task/methods/getReportTasks\">getReportTasks</a> method to retrieve report IDs.

try {
    $result = $apiInstance->getReport($reportId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdReportApi->getReport: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
reportId string This path parameter specifies the unique ID of the Promoted Listings report being retrieved.<br><br>Use the <a href=&quot;/api-docs/sell/marketing/resources/ad_report_task/methods/getReportTasks&quot;>getReportTasks</a> method to retrieve report IDs.

Return type

object

Authorization

api_auth, api_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/tab-separated-values

[Back to top] [Back to API list] [Back to Model list] [Back to README]