Skip to content

Latest commit

 

History

History
316 lines (198 loc) · 10.5 KB

ReportDefinitionServiceApi.md

File metadata and controls

316 lines (198 loc) · 10.5 KB

Yahoo\ReportDefinitionServiceApi

All URIs are relative to https://ads-search.yahooapis.jp/api/v1

Method HTTP request Description
reportDefinitionServiceAddPost POST /ReportDefinitionService/add
reportDefinitionServiceDownloadPost POST /ReportDefinitionService/download
reportDefinitionServiceGetPost POST /ReportDefinitionService/get
reportDefinitionServiceGetReportFieldsPost POST /ReportDefinitionService/getReportFields
reportDefinitionServiceRemovePost POST /ReportDefinitionService/remove

reportDefinitionServiceAddPost

\Yahoo\Model\ReportDefinitionServiceMutateResponse reportDefinitionServiceAddPost($reportDefinitionServiceOperation)

レポート定義を追加します。
Adds report definitions.

Example

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


// Configure OAuth2 access token for authorization: oAuth
$config = Yahoo\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yahoo\Api\ReportDefinitionServiceApi(
    // 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
);
$reportDefinitionServiceOperation = new \Yahoo\Model\ReportDefinitionServiceOperation(); // \Yahoo\Model\ReportDefinitionServiceOperation | 

try {
    $result = $apiInstance->reportDefinitionServiceAddPost($reportDefinitionServiceOperation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportDefinitionServiceApi->reportDefinitionServiceAddPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
reportDefinitionServiceOperation \Yahoo\Model\ReportDefinitionServiceOperation [optional]

Return type

\Yahoo\Model\ReportDefinitionServiceMutateResponse

Authorization

oAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

reportDefinitionServiceDownloadPost

\SplFileObject reportDefinitionServiceDownloadPost($reportDefinitionServiceDownloadSelector)

Example

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


// Configure OAuth2 access token for authorization: oAuth
$config = Yahoo\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yahoo\Api\ReportDefinitionServiceApi(
    // 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
);
$reportDefinitionServiceDownloadSelector = new \Yahoo\Model\ReportDefinitionServiceDownloadSelector(); // \Yahoo\Model\ReportDefinitionServiceDownloadSelector | 

try {
    $result = $apiInstance->reportDefinitionServiceDownloadPost($reportDefinitionServiceDownloadSelector);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportDefinitionServiceApi->reportDefinitionServiceDownloadPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
reportDefinitionServiceDownloadSelector \Yahoo\Model\ReportDefinitionServiceDownloadSelector [optional]

Return type

\SplFileObject

Authorization

oAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/octet-stream

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

reportDefinitionServiceGetPost

\Yahoo\Model\ReportDefinitionServiceGetResponse reportDefinitionServiceGetPost($reportDefinitionServiceSelector)

レポート定義に関する情報を取得します。
Get information related to report definition.

Example

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


// Configure OAuth2 access token for authorization: oAuth
$config = Yahoo\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yahoo\Api\ReportDefinitionServiceApi(
    // 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
);
$reportDefinitionServiceSelector = new \Yahoo\Model\ReportDefinitionServiceSelector(); // \Yahoo\Model\ReportDefinitionServiceSelector | 

try {
    $result = $apiInstance->reportDefinitionServiceGetPost($reportDefinitionServiceSelector);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportDefinitionServiceApi->reportDefinitionServiceGetPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
reportDefinitionServiceSelector \Yahoo\Model\ReportDefinitionServiceSelector [optional]

Return type

\Yahoo\Model\ReportDefinitionServiceGetResponse

Authorization

oAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

reportDefinitionServiceGetReportFieldsPost

\Yahoo\Model\ReportDefinitionServiceGetReportFieldsResponse reportDefinitionServiceGetReportFieldsPost($reportDefinitionServiceGetReportFields)

レポートタイプに対して使用可能なレポートのフィールドを返します。
Returns the available report fields for a given report type.

Example

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


// Configure OAuth2 access token for authorization: oAuth
$config = Yahoo\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yahoo\Api\ReportDefinitionServiceApi(
    // 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
);
$reportDefinitionServiceGetReportFields = new \Yahoo\Model\ReportDefinitionServiceGetReportFields(); // \Yahoo\Model\ReportDefinitionServiceGetReportFields | 

try {
    $result = $apiInstance->reportDefinitionServiceGetReportFieldsPost($reportDefinitionServiceGetReportFields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportDefinitionServiceApi->reportDefinitionServiceGetReportFieldsPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
reportDefinitionServiceGetReportFields \Yahoo\Model\ReportDefinitionServiceGetReportFields [optional]

Return type

\Yahoo\Model\ReportDefinitionServiceGetReportFieldsResponse

Authorization

oAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

reportDefinitionServiceRemovePost

\Yahoo\Model\ReportDefinitionServiceMutateResponse reportDefinitionServiceRemovePost($reportDefinitionServiceOperation)

レポート定義を削除します。
Removes report definitions.

Example

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


// Configure OAuth2 access token for authorization: oAuth
$config = Yahoo\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yahoo\Api\ReportDefinitionServiceApi(
    // 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
);
$reportDefinitionServiceOperation = new \Yahoo\Model\ReportDefinitionServiceOperation(); // \Yahoo\Model\ReportDefinitionServiceOperation | 

try {
    $result = $apiInstance->reportDefinitionServiceRemovePost($reportDefinitionServiceOperation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportDefinitionServiceApi->reportDefinitionServiceRemovePost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
reportDefinitionServiceOperation \Yahoo\Model\ReportDefinitionServiceOperation [optional]

Return type

\Yahoo\Model\ReportDefinitionServiceMutateResponse

Authorization

oAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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