CampaignExportServiceApi.md

Yahoo\CampaignExportServiceApi

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

Method	HTTP request	Description
campaignExportServiceAddJobPost	POST /CampaignExportService/addJob
campaignExportServiceDownloadPost	POST /CampaignExportService/download
campaignExportServiceGetExportFieldsGet	GET /CampaignExportService/getExportFields
campaignExportServiceGetPost	POST /CampaignExportService/get

campaignExportServiceAddJobPost

\Yahoo\Model\CampaignExportServiceAddJobResponse campaignExportServiceAddJobPost($campaignExportServiceJobOperation)

エクスポートの登録を実施します。

Creates job to register for export.

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\CampaignExportServiceApi(
    // 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
);
$campaignExportServiceJobOperation = new \Yahoo\Model\CampaignExportServiceJobOperation(); // \Yahoo\Model\CampaignExportServiceJobOperation | 

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

Parameters

Name	Type	Description	Notes
campaignExportServiceJobOperation	\Yahoo\Model\CampaignExportServiceJobOperation		[optional]

Return type

\Yahoo\Model\CampaignExportServiceAddJobResponse

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]

campaignExportServiceDownloadPost

\SplFileObject campaignExportServiceDownloadPost($campaignExportServiceDownloadSelector)

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\CampaignExportServiceApi(
    // 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
);
$campaignExportServiceDownloadSelector = new \Yahoo\Model\CampaignExportServiceDownloadSelector(); // \Yahoo\Model\CampaignExportServiceDownloadSelector | 

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

Parameters

Name	Type	Description	Notes
campaignExportServiceDownloadSelector	\Yahoo\Model\CampaignExportServiceDownloadSelector		[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]

campaignExportServiceGetExportFieldsGet

\Yahoo\Model\CampaignExportServiceGetExportFieldsResponse campaignExportServiceGetExportFieldsGet()

エクスポートできるフィールドを照会します。

Obtains the fields which can export.

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\CampaignExportServiceApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Yahoo\Model\CampaignExportServiceGetExportFieldsResponse

Authorization

oAuth

HTTP request headers

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

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

campaignExportServiceGetPost

\Yahoo\Model\CampaignExportServiceGetResponse campaignExportServiceGetPost($campaignExportServiceSelector)

登録したジョブに関するステータス情報を取得します。

Obtains the status of registered jobs.

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\CampaignExportServiceApi(
    // 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
);
$campaignExportServiceSelector = new \Yahoo\Model\CampaignExportServiceSelector(); // \Yahoo\Model\CampaignExportServiceSelector | 

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

Parameters

Name	Type	Description	Notes
campaignExportServiceSelector	\Yahoo\Model\CampaignExportServiceSelector		[optional]

Return type

\Yahoo\Model\CampaignExportServiceGetResponse

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]