Skip to content

Latest commit

 

History

History
256 lines (160 loc) · 8.22 KB

AccountSharedServiceApi.md

File metadata and controls

256 lines (160 loc) · 8.22 KB
Raw

Yahoo\AccountSharedServiceApi

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

Method HTTP request Description
accountSharedServiceAddPost POST /AccountSharedService/add
accountSharedServiceGetPost POST /AccountSharedService/get
accountSharedServiceRemovePost POST /AccountSharedService/remove
accountSharedServiceSetPost POST /AccountSharedService/set

accountSharedServiceAddPost

\Yahoo\Model\AccountSharedServiceMutateResponse accountSharedServiceAddPost($accountSharedServiceOperation)

アカウントに対象外キーワードリストを追加します。
Add negative keyword list to account.

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\AccountSharedServiceApi(
    // 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
);
$accountSharedServiceOperation = new \Yahoo\Model\AccountSharedServiceOperation(); // \Yahoo\Model\AccountSharedServiceOperation | 

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

Parameters

Name Type Description Notes
accountSharedServiceOperation \Yahoo\Model\AccountSharedServiceOperation [optional]

Return type

\Yahoo\Model\AccountSharedServiceMutateResponse

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]

accountSharedServiceGetPost

\Yahoo\Model\AccountSharedServiceGetResponse accountSharedServiceGetPost($accountSharedServiceSelector)

対象外キーワードリストの情報を取得します。
Get negative keyword list 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\AccountSharedServiceApi(
    // 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
);
$accountSharedServiceSelector = new \Yahoo\Model\AccountSharedServiceSelector(); // \Yahoo\Model\AccountSharedServiceSelector | 

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

Parameters

Name Type Description Notes
accountSharedServiceSelector \Yahoo\Model\AccountSharedServiceSelector [optional]

Return type

\Yahoo\Model\AccountSharedServiceGetResponse

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]

accountSharedServiceRemovePost

\Yahoo\Model\AccountSharedServiceMutateResponse accountSharedServiceRemovePost($accountSharedServiceOperation)

アカウントから対象外キーワードリストを削除します。
Remove negative keyword list from account.

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\AccountSharedServiceApi(
    // 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
);
$accountSharedServiceOperation = new \Yahoo\Model\AccountSharedServiceOperation(); // \Yahoo\Model\AccountSharedServiceOperation | 

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

Parameters

Name Type Description Notes
accountSharedServiceOperation \Yahoo\Model\AccountSharedServiceOperation [optional]

Return type

\Yahoo\Model\AccountSharedServiceMutateResponse

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]

accountSharedServiceSetPost

\Yahoo\Model\AccountSharedServiceMutateResponse accountSharedServiceSetPost($accountSharedServiceOperation)

対象外キーワードリストの設定を変更します。
Update negative keyword list information of account.

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\AccountSharedServiceApi(
    // 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
);
$accountSharedServiceOperation = new \Yahoo\Model\AccountSharedServiceOperation(); // \Yahoo\Model\AccountSharedServiceOperation | 

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

Parameters

Name Type Description Notes
accountSharedServiceOperation \Yahoo\Model\AccountSharedServiceOperation [optional]

Return type

\Yahoo\Model\AccountSharedServiceMutateResponse

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]