Skip to content

Latest commit

 

History

History
262 lines (166 loc) · 10.3 KB

OfflineConversionServiceApi.md

File metadata and controls

262 lines (166 loc) · 10.3 KB
Raw

Yahoo\OfflineConversionServiceApi

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

Method HTTP request Description
offlineConversionServiceDownloadErrorFilePost POST /OfflineConversionService/downloadErrorFile
offlineConversionServiceDownloadPost POST /OfflineConversionService/download
offlineConversionServiceGetPost POST /OfflineConversionService/get
offlineConversionServiceUploadPost POST /OfflineConversionService/upload

offlineConversionServiceDownloadErrorFilePost

\SplFileObject offlineConversionServiceDownloadErrorFilePost($offlineConversionServiceDownloadSelector)

エラーファイルのダウンロードを実施します。
Download error files.

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\OfflineConversionServiceApi(
    // 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
);
$offlineConversionServiceDownloadSelector = new \Yahoo\Model\OfflineConversionServiceDownloadSelector(); // \Yahoo\Model\OfflineConversionServiceDownloadSelector | 

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

Parameters

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

offlineConversionServiceDownloadPost

\SplFileObject offlineConversionServiceDownloadPost($offlineConversionServiceDownloadSelector)

ファイルの一括ダウンロードを実施します。
Download all files.

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\OfflineConversionServiceApi(
    // 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
);
$offlineConversionServiceDownloadSelector = new \Yahoo\Model\OfflineConversionServiceDownloadSelector(); // \Yahoo\Model\OfflineConversionServiceDownloadSelector | 

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

Parameters

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

offlineConversionServiceGetPost

\Yahoo\Model\OfflineConversionServiceGetResponse offlineConversionServiceGetPost($offlineConversionServiceSelector)

登録したオフラインコンバージョンデータの情報を取得します。
Get registered offline conversion data information.

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\OfflineConversionServiceApi(
    // 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
);
$offlineConversionServiceSelector = new \Yahoo\Model\OfflineConversionServiceSelector(); // \Yahoo\Model\OfflineConversionServiceSelector | 

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

Parameters

Name Type Description Notes
offlineConversionServiceSelector \Yahoo\Model\OfflineConversionServiceSelector [optional]

Return type

\Yahoo\Model\OfflineConversionServiceGetResponse

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]

offlineConversionServiceUploadPost

\Yahoo\Model\OfflineConversionServiceUploadResponse offlineConversionServiceUploadPost($accountId, $uploadType, $uploadFileName, $file)

オフラインコンバージョンデータのアップロード処理を実施します。
Execute upload offline conversion data.

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\OfflineConversionServiceApi(
    // 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
);
$accountId = 56; // int | <div lang=\"ja\">アカウントIDです。</div> <div lang=\"en\">Account ID.</div>
$uploadType = 'uploadType_example'; // string | <div lang=\"ja\">OfflineConversionUploadTypeは、アップロードする方法の種類を表します。</div><div lang=\"en\">OfflineConversionUploadType describes kind of upload method.</div><hr> <code>NEW</code> - <div lang=\"ja\">新規ファイルのアップロードです。</div><div lang=\"en\">New upload.</div> <code>ADJUSTMENT</code> - <div lang=\"ja\">調整用ファイルのアップロードです。</div><div lang=\"en\">Adjustment upload.</div>
$uploadFileName = 'uploadFileName_example'; // string | <div lang=\"ja\">アップロードファイル名です。</div> <div lang=\"en\">Upload file name.</div>
$file = "/path/to/file.txt"; // \SplFileObject | 

try {
    $result = $apiInstance->offlineConversionServiceUploadPost($accountId, $uploadType, $uploadFileName, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OfflineConversionServiceApi->offlineConversionServiceUploadPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
accountId int <div lang=&quot;ja&quot;>アカウントIDです。</div> <div lang=&quot;en&quot;>Account ID.</div>
uploadType string <div lang=&quot;ja&quot;>OfflineConversionUploadTypeは、アップロードする方法の種類を表します。</div><div lang=&quot;en&quot;>OfflineConversionUploadType describes kind of upload method.</div><hr> <code>NEW</code> - <div lang=&quot;ja&quot;>新規ファイルのアップロードです。</div><div lang=&quot;en&quot;>New upload.</div> <code>ADJUSTMENT</code> - <div lang=&quot;ja&quot;>調整用ファイルのアップロードです。</div><div lang=&quot;en&quot;>Adjustment upload.</div>
uploadFileName string <div lang=&quot;ja&quot;>アップロードファイル名です。</div> <div lang=&quot;en&quot;>Upload file name.</div>
file \SplFileObject**\SplFileObject** [optional]

Return type

\Yahoo\Model\OfflineConversionServiceUploadResponse

Authorization

oAuth

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

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