Skip to content

Latest commit

 

History

History
194 lines (121 loc) · 6.37 KB

CampaignWebpageServiceApi.md

File metadata and controls

194 lines (121 loc) · 6.37 KB

Yahoo\CampaignWebpageServiceApi

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

Method HTTP request Description
campaignWebpageServiceAddPost POST /CampaignWebpageService/add
campaignWebpageServiceGetPost POST /CampaignWebpageService/get
campaignWebpageServiceRemovePost POST /CampaignWebpageService/remove

campaignWebpageServiceAddPost

\Yahoo\Model\CampaignWebpageServiceMutateResponse campaignWebpageServiceAddPost($campaignWebpageServiceOperation)

キャンペーンにPageFeedItemを配信除外として設定します。
Set excluded settings of PageFeedItem for campaign.

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\CampaignWebpageServiceApi(
    // 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
);
$campaignWebpageServiceOperation = new \Yahoo\Model\CampaignWebpageServiceOperation(); // \Yahoo\Model\CampaignWebpageServiceOperation | 

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

Parameters

Name Type Description Notes
campaignWebpageServiceOperation \Yahoo\Model\CampaignWebpageServiceOperation [optional]

Return type

\Yahoo\Model\CampaignWebpageServiceMutateResponse

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]

campaignWebpageServiceGetPost

\Yahoo\Model\CampaignWebpageServiceGetResponse campaignWebpageServiceGetPost($campaignWebpageServiceSelector)

キャンペーンに設定されているPageFeedItemを照会します。
Get PageFeedItem setting in campaign.

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\CampaignWebpageServiceApi(
    // 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
);
$campaignWebpageServiceSelector = new \Yahoo\Model\CampaignWebpageServiceSelector(); // \Yahoo\Model\CampaignWebpageServiceSelector | 

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

Parameters

Name Type Description Notes
campaignWebpageServiceSelector \Yahoo\Model\CampaignWebpageServiceSelector [optional]

Return type

\Yahoo\Model\CampaignWebpageServiceGetResponse

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]

campaignWebpageServiceRemovePost

\Yahoo\Model\CampaignWebpageServiceMutateResponse campaignWebpageServiceRemovePost($campaignWebpageServiceOperation)

キャンペーンに関連付けしているPageFeedItemを解除します。
Remove PageFeedItem associated with campaign.

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\CampaignWebpageServiceApi(
    // 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
);
$campaignWebpageServiceOperation = new \Yahoo\Model\CampaignWebpageServiceOperation(); // \Yahoo\Model\CampaignWebpageServiceOperation | 

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

Parameters

Name Type Description Notes
campaignWebpageServiceOperation \Yahoo\Model\CampaignWebpageServiceOperation [optional]

Return type

\Yahoo\Model\CampaignWebpageServiceMutateResponse

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]