Skip to content

Latest commit

 

History

History
256 lines (160 loc) · 8.56 KB

CampaignTargetServiceApi.md

File metadata and controls

256 lines (160 loc) · 8.56 KB

Yahoo\CampaignTargetServiceApi

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

Method HTTP request Description
campaignTargetServiceAddPost POST /CampaignTargetService/add
campaignTargetServiceGetPost POST /CampaignTargetService/get
campaignTargetServiceRemovePost POST /CampaignTargetService/remove
campaignTargetServiceSetPost POST /CampaignTargetService/set

campaignTargetServiceAddPost

\Yahoo\Model\CampaignTargetServiceMutateResponse campaignTargetServiceAddPost($campaignTargetServiceOperation)

キャンペーンのターゲティング設定に関する情報を追加します。
Adds campaign informations related to targeting setting.

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\CampaignTargetServiceApi(
    // 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
);
$campaignTargetServiceOperation = new \Yahoo\Model\CampaignTargetServiceOperation(); // \Yahoo\Model\CampaignTargetServiceOperation | 

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

Parameters

Name Type Description Notes
campaignTargetServiceOperation \Yahoo\Model\CampaignTargetServiceOperation [optional]

Return type

\Yahoo\Model\CampaignTargetServiceMutateResponse

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]

campaignTargetServiceGetPost

\Yahoo\Model\CampaignTargetServiceGetResponse campaignTargetServiceGetPost($campaignTargetServiceSelector)

キャンペーンのターゲティング設定に関する情報を取得します。
Gets campaign informations related to targeting setting.

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\CampaignTargetServiceApi(
    // 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
);
$campaignTargetServiceSelector = new \Yahoo\Model\CampaignTargetServiceSelector(); // \Yahoo\Model\CampaignTargetServiceSelector | 

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

Parameters

Name Type Description Notes
campaignTargetServiceSelector \Yahoo\Model\CampaignTargetServiceSelector [optional]

Return type

\Yahoo\Model\CampaignTargetServiceGetResponse

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]

campaignTargetServiceRemovePost

\Yahoo\Model\CampaignTargetServiceMutateResponse campaignTargetServiceRemovePost($campaignTargetServiceOperation)

キャンペーンのターゲティング設定に関する情報を削除します。
Delete campaign informations related to targeting setting.

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\CampaignTargetServiceApi(
    // 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
);
$campaignTargetServiceOperation = new \Yahoo\Model\CampaignTargetServiceOperation(); // \Yahoo\Model\CampaignTargetServiceOperation | 

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

Parameters

Name Type Description Notes
campaignTargetServiceOperation \Yahoo\Model\CampaignTargetServiceOperation [optional]

Return type

\Yahoo\Model\CampaignTargetServiceMutateResponse

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]

campaignTargetServiceSetPost

\Yahoo\Model\CampaignTargetServiceMutateResponse campaignTargetServiceSetPost($campaignTargetServiceOperation)

キャンペーンのターゲティング設定に関する情報を変更します。※入札調整率（bidmultiplier）のみ変更可能です。
Update campaign informations related to targeting setting.
* Bid Adjustment (bidmultiplier) is only modifiable.

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\CampaignTargetServiceApi(
    // 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
);
$campaignTargetServiceOperation = new \Yahoo\Model\CampaignTargetServiceOperation(); // \Yahoo\Model\CampaignTargetServiceOperation | 

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

Parameters

Name Type Description Notes
campaignTargetServiceOperation \Yahoo\Model\CampaignTargetServiceOperation [optional]

Return type

\Yahoo\Model\CampaignTargetServiceMutateResponse

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]