Skip to content

Latest commit

 

History

History
256 lines (160 loc) · 9.08 KB

AdGroupRetargetingListServiceApi.md

File metadata and controls

256 lines (160 loc) · 9.08 KB

Yahoo\AdGroupRetargetingListServiceApi

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

Method HTTP request Description
adGroupRetargetingListServiceAddPost POST /AdGroupRetargetingListService/add
adGroupRetargetingListServiceGetPost POST /AdGroupRetargetingListService/get
adGroupRetargetingListServiceRemovePost POST /AdGroupRetargetingListService/remove
adGroupRetargetingListServiceSetPost POST /AdGroupRetargetingListService/set

adGroupRetargetingListServiceAddPost

\Yahoo\Model\AdGroupRetargetingListServiceMutateResponse adGroupRetargetingListServiceAddPost($adGroupRetargetingListServiceOperation)

広告グループレベルでのターゲットリスト設定を追加します。
Create the target list setting in ad group 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\AdGroupRetargetingListServiceApi(
    // 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
);
$adGroupRetargetingListServiceOperation = new \Yahoo\Model\AdGroupRetargetingListServiceOperation(); // \Yahoo\Model\AdGroupRetargetingListServiceOperation | 

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

Parameters

Name Type Description Notes
adGroupRetargetingListServiceOperation \Yahoo\Model\AdGroupRetargetingListServiceOperation [optional]

Return type

\Yahoo\Model\AdGroupRetargetingListServiceMutateResponse

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]

adGroupRetargetingListServiceGetPost

\Yahoo\Model\AdGroupRetargetingListServiceGetResponse adGroupRetargetingListServiceGetPost($adGroupRetargetingListServiceSelector)

広告グループレベルでのターゲットリスト設定に関する情報を取得します。
Retreive the target list setting in ad group 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\AdGroupRetargetingListServiceApi(
    // 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
);
$adGroupRetargetingListServiceSelector = new \Yahoo\Model\AdGroupRetargetingListServiceSelector(); // \Yahoo\Model\AdGroupRetargetingListServiceSelector | 

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

Parameters

Name Type Description Notes
adGroupRetargetingListServiceSelector \Yahoo\Model\AdGroupRetargetingListServiceSelector [optional]

Return type

\Yahoo\Model\AdGroupRetargetingListServiceGetResponse

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]

adGroupRetargetingListServiceRemovePost

\Yahoo\Model\AdGroupRetargetingListServiceMutateResponse adGroupRetargetingListServiceRemovePost($adGroupRetargetingListServiceOperation)

広告グループレベルでのターゲットリスト設定を削除します。
Delete the target list setting in ad group 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\AdGroupRetargetingListServiceApi(
    // 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
);
$adGroupRetargetingListServiceOperation = new \Yahoo\Model\AdGroupRetargetingListServiceOperation(); // \Yahoo\Model\AdGroupRetargetingListServiceOperation | 

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

Parameters

Name Type Description Notes
adGroupRetargetingListServiceOperation \Yahoo\Model\AdGroupRetargetingListServiceOperation [optional]

Return type

\Yahoo\Model\AdGroupRetargetingListServiceMutateResponse

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]

adGroupRetargetingListServiceSetPost

\Yahoo\Model\AdGroupRetargetingListServiceMutateResponse adGroupRetargetingListServiceSetPost($adGroupRetargetingListServiceOperation)

広告グループレベルでのターゲットリスト設定を更新します。
Update the target list setting in ad group 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\AdGroupRetargetingListServiceApi(
    // 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
);
$adGroupRetargetingListServiceOperation = new \Yahoo\Model\AdGroupRetargetingListServiceOperation(); // \Yahoo\Model\AdGroupRetargetingListServiceOperation | 

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

Parameters

Name Type Description Notes
adGroupRetargetingListServiceOperation \Yahoo\Model\AdGroupRetargetingListServiceOperation [optional]

Return type

\Yahoo\Model\AdGroupRetargetingListServiceMutateResponse

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]