Skip to content

Latest commit

 

History

History
256 lines (160 loc) · 8.41 KB

RetargetingListServiceApi.md

File metadata and controls

256 lines (160 loc) · 8.41 KB
Raw

Yahoo\RetargetingListServiceApi

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

Method HTTP request Description
retargetingListServiceAddPost POST /RetargetingListService/add
retargetingListServiceGetCustomKeyPost POST /RetargetingListService/getCustomKey
retargetingListServiceGetPost POST /RetargetingListService/get
retargetingListServiceSetPost POST /RetargetingListService/set

retargetingListServiceAddPost

\Yahoo\Model\RetargetingListServiceMutateResponse retargetingListServiceAddPost($retargetingListServiceOperation)

ターゲットリストを追加します。
Adds target list.

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\RetargetingListServiceApi(
    // 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
);
$retargetingListServiceOperation = new \Yahoo\Model\RetargetingListServiceOperation(); // \Yahoo\Model\RetargetingListServiceOperation | 

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

Parameters

Name Type Description Notes
retargetingListServiceOperation \Yahoo\Model\RetargetingListServiceOperation [optional]

Return type

\Yahoo\Model\RetargetingListServiceMutateResponse

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]

retargetingListServiceGetCustomKeyPost

\Yahoo\Model\RetargetingListServiceGetCustomKeyResponse retargetingListServiceGetCustomKeyPost($retargetingListServiceGetCustomKeySelector)

カスタムキーに関する情報を取得します。
Get custom key 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\RetargetingListServiceApi(
    // 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
);
$retargetingListServiceGetCustomKeySelector = new \Yahoo\Model\RetargetingListServiceGetCustomKeySelector(); // \Yahoo\Model\RetargetingListServiceGetCustomKeySelector | 

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

Parameters

Name Type Description Notes
retargetingListServiceGetCustomKeySelector \Yahoo\Model\RetargetingListServiceGetCustomKeySelector [optional]

Return type

\Yahoo\Model\RetargetingListServiceGetCustomKeyResponse

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]

retargetingListServiceGetPost

\Yahoo\Model\RetargetingListServiceGetResponse retargetingListServiceGetPost($retargetingListServiceSelector)

ターゲットリストに関する情報を取得します。
Retrieves the target list 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\RetargetingListServiceApi(
    // 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
);
$retargetingListServiceSelector = new \Yahoo\Model\RetargetingListServiceSelector(); // \Yahoo\Model\RetargetingListServiceSelector | 

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

Parameters

Name Type Description Notes
retargetingListServiceSelector \Yahoo\Model\RetargetingListServiceSelector [optional]

Return type

\Yahoo\Model\RetargetingListServiceGetResponse

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]

retargetingListServiceSetPost

\Yahoo\Model\RetargetingListServiceMutateResponse retargetingListServiceSetPost($retargetingListServiceOperation)

ターゲットリストを更新します。
Updates the target list.

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\RetargetingListServiceApi(
    // 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
);
$retargetingListServiceOperation = new \Yahoo\Model\RetargetingListServiceOperation(); // \Yahoo\Model\RetargetingListServiceOperation | 

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

Parameters

Name Type Description Notes
retargetingListServiceOperation \Yahoo\Model\RetargetingListServiceOperation [optional]

Return type

\Yahoo\Model\RetargetingListServiceMutateResponse

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]