CampaignFeedServiceApi.md

Yahoo\CampaignFeedServiceApi

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

Method	HTTP request	Description
campaignFeedServiceGetPost	POST /CampaignFeedService/get
campaignFeedServiceSetPost	POST /CampaignFeedService/set

campaignFeedServiceGetPost

\Yahoo\Model\CampaignFeedServiceGetResponse campaignFeedServiceGetPost($campaignFeedServiceSelector)

キャンペーンのFeedItem情報を取得します。

Get FeedItem information of 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\CampaignFeedServiceApi(
    // 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
);
$campaignFeedServiceSelector = new \Yahoo\Model\CampaignFeedServiceSelector(); // \Yahoo\Model\CampaignFeedServiceSelector | 

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

Parameters

Name	Type	Description	Notes
campaignFeedServiceSelector	\Yahoo\Model\CampaignFeedServiceSelector		[optional]

Return type

\Yahoo\Model\CampaignFeedServiceGetResponse

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]

campaignFeedServiceSetPost

\Yahoo\Model\CampaignFeedServiceMutateResponse campaignFeedServiceSetPost($campaignFeedServiceOperation)

キャンペーンにFeedItem情報を追加・更新・解除（削除）します。
・FeedItem情報を解除するときは空の情報で更新します。
・1つのキャンペーンに設定できるFeedItem情報は、QUICKLINKS、CALLEXTENSIONでそれぞれ20件までです。
・CALLEXTENSIONについて1キャンペーンあたり1件の設定をお薦めします。
・1リクエスト内で同一のcampaignIdに複数のFeedItem情報は設定できません。

Add, update or release(remove) FeedItem information of ad group.
Update will overwrite the old information, so have to include the additional information on every updates.
* To release FeedItem information, update with blank data.
* It is possible to set FeedItem information to ad groups in different campaigns by single request.
* FeedItem information that can be set for a single ad group is up to 20 for each QUICKLINKS, CALLEXTENSION.
* As for CALLEXTENSION, We recommend setting only one phone number per ad group.
* It is not possible to set multiple FeedItem information to an campaignId by single request.

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\CampaignFeedServiceApi(
    // 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
);
$campaignFeedServiceOperation = new \Yahoo\Model\CampaignFeedServiceOperation(); // \Yahoo\Model\CampaignFeedServiceOperation | 

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

Parameters

Name	Type	Description	Notes
campaignFeedServiceOperation	\Yahoo\Model\CampaignFeedServiceOperation		[optional]

Return type

\Yahoo\Model\CampaignFeedServiceMutateResponse

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]