Skip to content

Latest commit

 

History

History
256 lines (160 loc) · 7.57 KB

AdGroupServiceApi.md

File metadata and controls

256 lines (160 loc) · 7.57 KB

Yahoo\AdGroupServiceApi

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

Method HTTP request Description
adGroupServiceAddPost POST /AdGroupService/add
adGroupServiceGetPost POST /AdGroupService/get
adGroupServiceRemovePost POST /AdGroupService/remove
adGroupServiceSetPost POST /AdGroupService/set

adGroupServiceAddPost

\Yahoo\Model\AdGroupServiceMutateResponse adGroupServiceAddPost($adGroupServiceOperation)

広告グループを追加します。
Create Ad group 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\AdGroupServiceApi(
    // 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
);
$adGroupServiceOperation = new \Yahoo\Model\AdGroupServiceOperation(); // \Yahoo\Model\AdGroupServiceOperation | 

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

Parameters

Name Type Description Notes
adGroupServiceOperation \Yahoo\Model\AdGroupServiceOperation [optional]

Return type

\Yahoo\Model\AdGroupServiceMutateResponse

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]

adGroupServiceGetPost

\Yahoo\Model\AdGroupServiceGetResponse adGroupServiceGetPost($adGroupServiceSelector)

広告グループに関する情報を取得します。
Gets Ad group 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\AdGroupServiceApi(
    // 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
);
$adGroupServiceSelector = new \Yahoo\Model\AdGroupServiceSelector(); // \Yahoo\Model\AdGroupServiceSelector | 

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

Parameters

Name Type Description Notes
adGroupServiceSelector \Yahoo\Model\AdGroupServiceSelector [optional]

Return type

\Yahoo\Model\AdGroupServiceGetResponse

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]

adGroupServiceRemovePost

\Yahoo\Model\AdGroupServiceMutateResponse adGroupServiceRemovePost($adGroupServiceOperation)

広告グループを削除します。
Removes Ad group 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\AdGroupServiceApi(
    // 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
);
$adGroupServiceOperation = new \Yahoo\Model\AdGroupServiceOperation(); // \Yahoo\Model\AdGroupServiceOperation | 

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

Parameters

Name Type Description Notes
adGroupServiceOperation \Yahoo\Model\AdGroupServiceOperation [optional]

Return type

\Yahoo\Model\AdGroupServiceMutateResponse

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]

adGroupServiceSetPost

\Yahoo\Model\AdGroupServiceMutateResponse adGroupServiceSetPost($adGroupServiceOperation)

広告グループを更新します。
Updates Ad group 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\AdGroupServiceApi(
    // 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
);
$adGroupServiceOperation = new \Yahoo\Model\AdGroupServiceOperation(); // \Yahoo\Model\AdGroupServiceOperation | 

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

Parameters

Name Type Description Notes
adGroupServiceOperation \Yahoo\Model\AdGroupServiceOperation [optional]

Return type

\Yahoo\Model\AdGroupServiceMutateResponse

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]