Yahoo\PageFeedItemServiceApi

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

Method	HTTP request	Description
pageFeedItemServiceAddDownloadJobPost	POST /PageFeedItemService/addDownloadJob
pageFeedItemServiceDownloadErrorFilePost	POST /PageFeedItemService/downloadErrorFile
pageFeedItemServiceDownloadPost	POST /PageFeedItemService/download
pageFeedItemServiceGetJobStatusPost	POST /PageFeedItemService/getJobStatus
pageFeedItemServiceGetPost	POST /PageFeedItemService/get
pageFeedItemServiceGetReviewSummaryPost	POST /PageFeedItemService/getReviewSummary
pageFeedItemServiceUploadPost	POST /PageFeedItemService/upload

pageFeedItemServiceAddDownloadJobPost

\Yahoo\Model\PageFeedItemServiceAddDownloadJobResponse pageFeedItemServiceAddDownloadJobPost($pageFeedItemServiceDownloadJobOperation)

登録されているページフィードアイテムを一括でダウンロードするためジョブを登録します。

Registers job to bulk download registered page feed item.

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\PageFeedItemServiceApi(
    // 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
);
$pageFeedItemServiceDownloadJobOperation = new \Yahoo\Model\PageFeedItemServiceDownloadJobOperation(); // \Yahoo\Model\PageFeedItemServiceDownloadJobOperation | 

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

Parameters

Name	Type	Description	Notes
pageFeedItemServiceDownloadJobOperation	\Yahoo\Model\PageFeedItemServiceDownloadJobOperation		[optional]

Return type

\Yahoo\Model\PageFeedItemServiceAddDownloadJobResponse

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]

pageFeedItemServiceDownloadErrorFilePost

\SplFileObject pageFeedItemServiceDownloadErrorFilePost($pageFeedItemServiceDownloadSelector)

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\PageFeedItemServiceApi(
    // 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
);
$pageFeedItemServiceDownloadSelector = new \Yahoo\Model\PageFeedItemServiceDownloadSelector(); // \Yahoo\Model\PageFeedItemServiceDownloadSelector | 

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

Parameters

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

pageFeedItemServiceDownloadPost

\SplFileObject pageFeedItemServiceDownloadPost($pageFeedItemServiceDownloadSelector)

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\PageFeedItemServiceApi(
    // 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
);
$pageFeedItemServiceDownloadSelector = new \Yahoo\Model\PageFeedItemServiceDownloadSelector(); // \Yahoo\Model\PageFeedItemServiceDownloadSelector | 

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

Parameters

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

pageFeedItemServiceGetJobStatusPost

\Yahoo\Model\PageFeedItemServiceGetJobStatusResponse pageFeedItemServiceGetJobStatusPost($pageFeedItemServiceJobStatusSelector)

upload、downloadの処理状況を取得します。downloadJobStatusがCOMPLETEDの場合、レスポンスにダウンロードURLが設定されます。

Gets processing status about upload or download. If downloadJobStatus is COMPLETED, returns download URL as response.

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\PageFeedItemServiceApi(
    // 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
);
$pageFeedItemServiceJobStatusSelector = new \Yahoo\Model\PageFeedItemServiceJobStatusSelector(); // \Yahoo\Model\PageFeedItemServiceJobStatusSelector | 

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

Parameters

Name	Type	Description	Notes
pageFeedItemServiceJobStatusSelector	\Yahoo\Model\PageFeedItemServiceJobStatusSelector		[optional]

Return type

\Yahoo\Model\PageFeedItemServiceGetJobStatusResponse

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]

pageFeedItemServiceGetPost

\Yahoo\Model\PageFeedItemServiceGetResponse pageFeedItemServiceGetPost($pageFeedItemServiceSelector)

ページフィードアイテム情報を取得します。

Gets information related to page feed item.

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\PageFeedItemServiceApi(
    // 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
);
$pageFeedItemServiceSelector = new \Yahoo\Model\PageFeedItemServiceSelector(); // \Yahoo\Model\PageFeedItemServiceSelector | 

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

Parameters

Name	Type	Description	Notes
pageFeedItemServiceSelector	\Yahoo\Model\PageFeedItemServiceSelector		[optional]

Return type

\Yahoo\Model\PageFeedItemServiceGetResponse

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]

pageFeedItemServiceGetReviewSummaryPost

\Yahoo\Model\PageFeedItemServiceGetReviewSummaryResponse pageFeedItemServiceGetReviewSummaryPost($pageFeedItemServiceReviewSummarySelector)

登録されているページフィードアイテムの審査成績・状況のサマリーを取得します。

Gets registered approval records of page feed item and summary of each status.

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\PageFeedItemServiceApi(
    // 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
);
$pageFeedItemServiceReviewSummarySelector = new \Yahoo\Model\PageFeedItemServiceReviewSummarySelector(); // \Yahoo\Model\PageFeedItemServiceReviewSummarySelector | 

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

Parameters

Name	Type	Description	Notes
pageFeedItemServiceReviewSummarySelector	\Yahoo\Model\PageFeedItemServiceReviewSummarySelector		[optional]

Return type

\Yahoo\Model\PageFeedItemServiceGetReviewSummaryResponse

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]

pageFeedItemServiceUploadPost

\Yahoo\Model\PageFeedItemServiceUploadResponse pageFeedItemServiceUploadPost($accountId, $uploadType, $feedId, $file)

ページフィードアイテムのアップロード処理を実施します。

Executes upload page feed item.

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\PageFeedItemServiceApi(
    // 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\">PageFeedItemUploadTypeは、アップロードする方法の種類を表します。</div><div lang=\"en\">PageFeedItemUploadType displays kind of upload method.</div><hr> <code>NEW_OR_REPLACE</code> - <div lang=\"ja\">新規登録または、すべて置き換える場合の設定</div><div lang=\"en\">New registration or replace all.</div> <code>MODIFY</code> - <div lang=\"ja\">既存のページフィードアイテムを更新</div><div lang=\"en\">Modify existing page feed item.</div>
$feedId = 56; // int | <div lang=\"ja\">フィードIDです。</div><div lang=\"en\">Feed ID.</div>
$file = "/path/to/file.txt"; // \SplFileObject | 

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

Parameters

Name	Type	Description	Notes
accountId	int	<div lang="ja">アカウントIDです。</div><div lang="en">Account ID.</div>
uploadType	string	<div lang="ja">PageFeedItemUploadTypeは、アップロードする方法の種類を表します。</div><div lang="en">PageFeedItemUploadType displays kind of upload method.</div><hr> <code>NEW_OR_REPLACE</code> - <div lang="ja">新規登録または、すべて置き換える場合の設定</div><div lang="en">New registration or replace all.</div> <code>MODIFY</code> - <div lang="ja">既存のページフィードアイテムを更新</div><div lang="en">Modify existing page feed item.</div>
feedId	int	<div lang="ja">フィードIDです。</div><div lang="en">Feed ID.</div>
file	\SplFileObject\SplFileObject		[optional]

Return type

\Yahoo\Model\PageFeedItemServiceUploadResponse

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]

Files

PageFeedItemServiceApi.md

Latest commit

History

PageFeedItemServiceApi.md

File metadata and controls

Yahoo\PageFeedItemServiceApi

pageFeedItemServiceAddDownloadJobPost

Example

Parameters

Return type

Authorization

HTTP request headers

pageFeedItemServiceDownloadErrorFilePost

Example

Parameters

Return type

Authorization

HTTP request headers

pageFeedItemServiceDownloadPost

Example

Parameters

Return type

Authorization

HTTP request headers

pageFeedItemServiceGetJobStatusPost

Example

Parameters

Return type

Authorization

HTTP request headers

pageFeedItemServiceGetPost

Example

Parameters

Return type

Authorization

HTTP request headers

pageFeedItemServiceGetReviewSummaryPost

Example

Parameters

Return type

Authorization

HTTP request headers

pageFeedItemServiceUploadPost

Example

Parameters

Return type

Authorization

HTTP request headers