Skip to content

Latest commit

 

History

History
256 lines (160 loc) · 9.19 KB

CampaignRetargetingListServiceApi.md

File metadata and controls

256 lines (160 loc) · 9.19 KB
Raw

Yahoo\CampaignRetargetingListServiceApi

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

Method HTTP request Description
campaignRetargetingListServiceAddPost POST /CampaignRetargetingListService/add
campaignRetargetingListServiceGetPost POST /CampaignRetargetingListService/get
campaignRetargetingListServiceRemovePost POST /CampaignRetargetingListService/remove
campaignRetargetingListServiceSetPost POST /CampaignRetargetingListService/set

campaignRetargetingListServiceAddPost

\Yahoo\Model\CampaignRetargetingListServiceMutateResponse campaignRetargetingListServiceAddPost($campaignRetargetingListServiceOperation)

キャンペーン階層におけるターゲットリストの設定情報を追加します。
Adds the target list setting in campaign level.

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\CampaignRetargetingListServiceApi(
    // 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
);
$campaignRetargetingListServiceOperation = new \Yahoo\Model\CampaignRetargetingListServiceOperation(); // \Yahoo\Model\CampaignRetargetingListServiceOperation | 

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

Parameters

Name Type Description Notes
campaignRetargetingListServiceOperation \Yahoo\Model\CampaignRetargetingListServiceOperation [optional]

Return type

\Yahoo\Model\CampaignRetargetingListServiceMutateResponse

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]

campaignRetargetingListServiceGetPost

\Yahoo\Model\CampaignRetargetingListServiceGetResponse campaignRetargetingListServiceGetPost($campaignRetargetingListServiceSelector)

キャンペーン階層におけるターゲットリストの設定情報を取得します。
Retreive the target list setting in campaign level.

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\CampaignRetargetingListServiceApi(
    // 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
);
$campaignRetargetingListServiceSelector = new \Yahoo\Model\CampaignRetargetingListServiceSelector(); // \Yahoo\Model\CampaignRetargetingListServiceSelector | 

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

Parameters

Name Type Description Notes
campaignRetargetingListServiceSelector \Yahoo\Model\CampaignRetargetingListServiceSelector [optional]

Return type

\Yahoo\Model\CampaignRetargetingListServiceGetResponse

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]

campaignRetargetingListServiceRemovePost

\Yahoo\Model\CampaignRetargetingListServiceMutateResponse campaignRetargetingListServiceRemovePost($campaignRetargetingListServiceOperation)

キャンペーン階層におけるターゲットリストの設定情報を削除します。
Delete the target list setting in campaign level.

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\CampaignRetargetingListServiceApi(
    // 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
);
$campaignRetargetingListServiceOperation = new \Yahoo\Model\CampaignRetargetingListServiceOperation(); // \Yahoo\Model\CampaignRetargetingListServiceOperation | 

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

Parameters

Name Type Description Notes
campaignRetargetingListServiceOperation \Yahoo\Model\CampaignRetargetingListServiceOperation [optional]

Return type

\Yahoo\Model\CampaignRetargetingListServiceMutateResponse

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]

campaignRetargetingListServiceSetPost

\Yahoo\Model\CampaignRetargetingListServiceMutateResponse campaignRetargetingListServiceSetPost($campaignRetargetingListServiceOperation)

キャンペーン階層におけるターゲットリストの設定情報を更新します。
Updates the target list setting in campaign level.

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\CampaignRetargetingListServiceApi(
    // 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
);
$campaignRetargetingListServiceOperation = new \Yahoo\Model\CampaignRetargetingListServiceOperation(); // \Yahoo\Model\CampaignRetargetingListServiceOperation | 

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

Parameters

Name Type Description Notes
campaignRetargetingListServiceOperation \Yahoo\Model\CampaignRetargetingListServiceOperation [optional]

Return type

\Yahoo\Model\CampaignRetargetingListServiceMutateResponse

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]