Skip to content

Latest commit

 

History

History
318 lines (199 loc) · 10 KB

AdGroupAdServiceApi.md

File metadata and controls

318 lines (199 loc) · 10 KB
Raw

Yahoo\AdGroupAdServiceApi

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

Method HTTP request Description
adGroupAdServiceAddPost POST /AdGroupAdService/add
adGroupAdServiceGetPost POST /AdGroupAdService/get
adGroupAdServiceRemovePost POST /AdGroupAdService/remove
adGroupAdServiceSetPost POST /AdGroupAdService/set
adGroupAdServiceSetTrademarkStatusPost POST /AdGroupAdService/setTrademarkStatus

adGroupAdServiceAddPost

\Yahoo\Model\AdGroupAdServiceMutateResponse adGroupAdServiceAddPost($adGroupAdServiceOperation)

広告に関する情報を追加します。
Add informations of ad.

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\AdGroupAdServiceApi(
    // 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
);
$adGroupAdServiceOperation = new \Yahoo\Model\AdGroupAdServiceOperation(); // \Yahoo\Model\AdGroupAdServiceOperation | 

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

Parameters

Name Type Description Notes
adGroupAdServiceOperation \Yahoo\Model\AdGroupAdServiceOperation [optional]

Return type

\Yahoo\Model\AdGroupAdServiceMutateResponse

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]

adGroupAdServiceGetPost

\Yahoo\Model\AdGroupAdServiceGetResponse adGroupAdServiceGetPost($adGroupAdServiceSelector)

広告に関する情報を取得します。
Returns ad 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\AdGroupAdServiceApi(
    // 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
);
$adGroupAdServiceSelector = new \Yahoo\Model\AdGroupAdServiceSelector(); // \Yahoo\Model\AdGroupAdServiceSelector | 

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

Parameters

Name Type Description Notes
adGroupAdServiceSelector \Yahoo\Model\AdGroupAdServiceSelector [optional]

Return type

\Yahoo\Model\AdGroupAdServiceGetResponse

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]

adGroupAdServiceRemovePost

\Yahoo\Model\AdGroupAdServiceMutateResponse adGroupAdServiceRemovePost($adGroupAdServiceOperation)

広告に関する情報を削除します。
Remove ad 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\AdGroupAdServiceApi(
    // 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
);
$adGroupAdServiceOperation = new \Yahoo\Model\AdGroupAdServiceOperation(); // \Yahoo\Model\AdGroupAdServiceOperation | 

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

Parameters

Name Type Description Notes
adGroupAdServiceOperation \Yahoo\Model\AdGroupAdServiceOperation [optional]

Return type

\Yahoo\Model\AdGroupAdServiceMutateResponse

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]

adGroupAdServiceSetPost

\Yahoo\Model\AdGroupAdServiceMutateResponse adGroupAdServiceSetPost($adGroupAdServiceOperation)

広告に関する情報を更新します。
Updates ad 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\AdGroupAdServiceApi(
    // 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
);
$adGroupAdServiceOperation = new \Yahoo\Model\AdGroupAdServiceOperation(); // \Yahoo\Model\AdGroupAdServiceOperation | 

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

Parameters

Name Type Description Notes
adGroupAdServiceOperation \Yahoo\Model\AdGroupAdServiceOperation [optional]

Return type

\Yahoo\Model\AdGroupAdServiceMutateResponse

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]

adGroupAdServiceSetTrademarkStatusPost

\Yahoo\Model\AdGroupAdServiceSetTrademarkStatusResponse adGroupAdServiceSetTrademarkStatusPost($adGroupAdServiceSetTrademarkStatusOperation)

商標の使用制限が解除されている場合は、制限が解除された旨の値が返却されます。
When the trademark restriction is removed, a value indicates \"removed\" will be returned.

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\AdGroupAdServiceApi(
    // 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
);
$adGroupAdServiceSetTrademarkStatusOperation = new \Yahoo\Model\AdGroupAdServiceSetTrademarkStatusOperation(); // \Yahoo\Model\AdGroupAdServiceSetTrademarkStatusOperation | 

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

Parameters

Name Type Description Notes
adGroupAdServiceSetTrademarkStatusOperation \Yahoo\Model\AdGroupAdServiceSetTrademarkStatusOperation [optional]

Return type

\Yahoo\Model\AdGroupAdServiceSetTrademarkStatusResponse

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]