jp.co.yahoo.adssearchapi.v13.api.AdGroupServiceApi Maven / Gradle / Ivy
Show all versions of ads-search-api-lib Show documentation
package jp.co.yahoo.adssearchapi.v13.api;
import jp.co.yahoo.adssearchapi.v13.ApiClient;
import jp.co.yahoo.adssearchapi.v13.model.AdGroupServiceGetResponse;
import jp.co.yahoo.adssearchapi.v13.model.AdGroupServiceMutateResponse;
import jp.co.yahoo.adssearchapi.v13.model.AdGroupServiceOperation;
import jp.co.yahoo.adssearchapi.v13.model.AdGroupServiceSelector;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.stream.Collectors;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.web.client.RestClientException;
import org.springframework.web.client.HttpClientErrorException;
import org.springframework.core.ParameterizedTypeReference;
import org.springframework.core.io.FileSystemResource;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
@Component("jp.co.yahoo.adssearchapi.v13.api.AdGroupServiceApi")
public class AdGroupServiceApi {
private ApiClient apiClient;
public AdGroupServiceApi() {
this(new ApiClient());
}
@Autowired
public AdGroupServiceApi(ApiClient apiClient) {
this.apiClient = apiClient;
}
public ApiClient getApiClient() {
return apiClient;
}
public void setApiClient(ApiClient apiClient) {
this.apiClient = apiClient;
}
/**
*
* <div lang=\"ja\">広告グループを追加します。</div> <div lang=\"en\">Create Ad group information.</div>
* 503 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0099</td><td>Out of service.</td><td><div lang=\"ja\">APIがメンテナンス中、またはご利用できません。</div><div lang=\"en\">API is under maintenance or not available to use.</div></td></tr> </tbody> </table> </div>
*
500 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0002</td><td>An internal error has occurred.</td><td><div lang=\"ja\">内部エラーが発生しました。再度操作を実行してください。 <br>もし、問題が解決しない場合は、お問い合わせページをご利用ください。</div><div lang=\"en\">An internal error has occurred. Please try again later. <br>If the problem continues, please contact the support team via Inquiry page for assistance. </div></td></tr> </tbody> </table> </div>
*
200 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0001</td><td>Invalid Request.</td><td><div lang=\"ja\">さまざまな要因が考えられます。<br>主な要因は、パラメータの値が不正か、誤りがあるためにオペレーションが完了できません。</div><div lang=\"en\">This error can result for a variety of reasons. <br>Typically because one of the parameter values in the request is wrong or invalid and the operation cannot be completed.</div></td></tr> <tr><td>R0001</td><td>Require.</td><td><div lang=\"ja\">必須です。</div><div lang=\"en\">It is missing required parameter.</div></td></tr> <tr><td>F0001</td><td>Invalid format.</td><td><div lang=\"ja\">値の形式が不正です。</div><div lang=\"en\">The value format is invalid.</div></td></tr> <tr><td>V0001</td><td>Invalid value.</td><td><div lang=\"ja\">値が無効です。</div><div lang=\"en\">The value is invalid.</div></td></tr> <tr><td>S0001</td><td>Invalid Status.</td><td><div lang=\"ja\">ステータスが無効です。</div><div lang=\"en\">The status is invalid.</div></td></tr> <tr><td>L0002</td><td>Over list size.</td><td><div lang=\"ja\">配列の要素数が上限値を超過しています。</div><div lang=\"en\">The number of elements in the array exceeds the upper limit.</div></td></tr> <tr><td>L0001</td><td>Lower list size.</td><td><div lang=\"ja\">配列の要素数が下限値を下回っています。</div><div lang=\"en\">The number of elements in the array is below the lower limit.</div></td></tr> <tr><td>D0001</td><td>Duplicate.</td><td><div lang=\"ja\">一意な値が重複しています。</div><div lang=\"en\">The unique value is duplicated.</div></td></tr> <tr><td>RL001</td><td>Invalid relation.</td><td><div lang=\"ja\">リクエストの関連性が矛盾しています。<br> たとえば、開始>終了の日付指定を行なっているなど</div><div lang=\"en\">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr> <tr><td>LT001</td><td>Over limit.</td><td><div lang=\"ja\">登録できる上限値を超過しています。</div><div lang=\"en\">The upper limit value that can be registered is exceeded.</div></td></tr> <tr><td>I0001</td><td>Deactivated Id.</td><td><div lang=\"ja\">IDが無効です。</div><div lang=\"en\">The ID is Deactivated.</div></td></tr> <tr><td>130000</td><td>The server is busy. Please retry later.</td><td><div lang=\"ja\">サーバーが高負荷です。時間をおいて再試行してください。</div><div lang=\"en\">The server is busy. Please retry later.</div></td></tr> <tr><td>130001</td><td>The request was not completed. Please reduce concurrent requests or data size. </td><td><div lang=\"ja\">リクエストが完了しませんでした。同時リクエスト数またはデータサイズを減らして再度お試しください。</div><div lang=\"en\">The request was not completed. Please reduce concurrent requests or data size.</div></td></tr> <tr><td>210405</td><td>Budget has exceeded.</td><td><div lang=\"ja\">予算額を超過しています。</div><div lang=\"en\">The budget amount is exceeded.</div></td></tr> <tr><td>210303</td><td>Invalid conversion tracking.</td><td><div lang=\"ja\">コンバージョントラッキングが無効です。</div><div lang=\"en\">Conversion tracking is Invalid.</div></td></tr> <tr><td>210301</td><td>Setting the disabled Auto bidding.</td><td><div lang=\"ja\">編集中(削除含む)の自動入札を指定しています。</div><div lang=\"en\">Auto bidding in editing (including deletion) is specified.</div></td></tr> <tr><td>210304</td><td>Not enough conversions or invalid setting.</td><td><div lang=\"ja\">コンバージョン数が不十分です。</div><div lang=\"en\">Conversions is not enough.</div></td></tr> <tr><td>210305</td><td>Auto bidding is already set.</td><td><div lang=\"ja\">キーワードに個別の入札価格や入札設定が指定されている状態で、キャンペーンに「コンバージョン数の最大化」、または「コンバージョン単価の目標値」の自動入札を設定しております。</div><div lang=\"en\">Auto bidding of \"Enhanced CPC\" or \"Target conversion spend\" is set for campaigns with individual bidding prices and bidding settings specified for keywords.</div></td></tr> <tr><td>210306</td><td>Cannot use conversion optimizer.</td><td><div lang=\"ja\">コンバージョンオプティマイザーが利用できません。</div><div lang=\"en\">Conversion optimizer cannot be used.</div></td></tr> <tr><td>210308</td><td>Set campaign active.</td><td><div lang=\"ja\">キャンペーンがACTIVEでないため、入札設定が利用できません。</div><div lang=\"en\">Since the campaign is not ACTIVE, the bidding settings can not be used.</div></td></tr> <tr><td>210309</td><td>Set campaign to CPC.</td><td><div lang=\"ja\">キャンペーンが「CPC」でないため、入札設定が利用できません。</div><div lang=\"en\">Since the campaign is not \"CPC\", bidding settings can not be used.</div></td></tr> <tr><td>210409</td><td>AdGroupServiceBid setting limit has exceed.</td><td><div lang=\"ja\">キャンペーン配下の広告広告グループに設定した入札金額または自動入札設定数が上限を超えています。<br>※1キャンペーンに設定できる入札金額および自動入札設定は、配下の広告グループ合計で1000件までです。</div><div lang=\"en\">The bid amount or Auto bidding number set for the ad / ad group under the campaign exceeds the maximum limit. <br> * 1 The maximum bid amount and Auto bidding setting that can be set for the campaign is 1000 in total for the ad group below.</div></td></tr> <tr><td>211000</td><td>Cannot operate AdvancedURL(FinalURL).</td><td><div lang=\"ja\">アドバンスドURLに移行済みのため、操作できません。</div><div lang=\"en\">Since it has already been transferred to AdvancedURL(FinalURL), it can not be operated.</div></td></tr> <tr><td>211001</td><td>Cannot set AdvancedMobileURL(SmartphoneFinalURL).</td><td><div lang=\"ja\">アプリダウンロードキャンペーンでは、advancedMobileURL(smartphoneFinalURL)の設定はできません。</div><div lang=\"en\">In the app download campaign, AdvancedMobileURL(SmartphoneFinalURL) can not be set.</div></td></tr> <tr><td>211003</td><td>Domain does not match with DisplayURL.</td><td><div lang=\"ja\">表示URLと最終リンク先URLのドメインが一致していません。</div><div lang=\"en\">Domain of DisplayURL and FinalUrl do not match.</div></td></tr> <tr><td>211004</td><td>Cannot set under AndroidCampaign.</td><td><div lang=\"ja\">Androidのアプリキャンペーンでは、以下の設定ができません:<br>・キャンペーン、広告グループ、広告、キーワードにTrackingUrlや CustomParameterを設定<br>・キーワードに最終リンク先URLやスマートフォン向けURLを設定</div><div lang=\"en\">In the Android app campaign, the following settings can not be made:<br>・Set TrackingUrl and CustomParameter for campaigns, ad groups, ads, keywords<br>・Set the AdvancedUrl(FinalUrl) and AdvancedMobileUrl(SmartphoneFinalUrl) for the keywords</div></td></tr> </tbody> </table> </div>
*
403 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0098</td><td>Permission denied.</td><td><div lang=\"ja\">権限がありません。</div><div lang=\"en\">Permission denied.</div></td></tr> <tr><td>0003</td><td>Frequency limit exceeded. Please try your request again later</td><td><div lang=\"ja\">アクセス頻度が上限値に達しました。時間をおいて再度実行してください。</div><div lang=\"en\">Frequency limit exceeded. Please try your request again later.</div></td></tr> </tbody> </table> </div>
*
401 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0110</td><td>Require access token.</td><td><div lang=\"ja\">アクセストークンがリクエストヘッダに存在していません。</div><div lang=\"en\">There is no access token in the request header.</div></td></tr> <tr><td>0111</td><td>Authentication failed.</td><td><div lang=\"ja\">アクセストークンの認証に失敗しました。</div><div lang=\"en\">The access token authentication failed.</div></td></tr> <tr><td>0112</td><td>Account not found.</td><td><div lang=\"ja\">アカウントが見つかりませんでした。</div><div lang=\"en\">The account can not found.</div></td></tr> <tr><td>0113</td><td>Deactivated account.</td><td><div lang=\"ja\">アカウントが無効です。</div><div lang=\"en\">The account is deactivated.</div></td></tr> </tbody> </table> </div>
*
400 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0114</td><td>Invalid scope.</td><td><div lang=\"ja\">アクセストークンが無効です。</div><div lang=\"en\">The access token is invalid.</div></td></tr> </tbody> </table> </div>
* @param xZBaseAccountId <div lang=\"ja\">アカウントIDを指定してください。</div> <div lang=\"en\">Specify Account ID.</div> (required)
* @param adGroupServiceOperation (optional)
* @return AdGroupServiceMutateResponse
* @throws RestClientException if an error occurs while attempting to invoke the API
*/
public AdGroupServiceMutateResponse adGroupServiceAddPost(Long xZBaseAccountId, AdGroupServiceOperation adGroupServiceOperation) throws RestClientException {
return adGroupServiceAddPostWithHttpInfo(xZBaseAccountId, adGroupServiceOperation).getBody();
}
/**
*
* <div lang=\"ja\">広告グループを追加します。</div> <div lang=\"en\">Create Ad group information.</div>
*
503 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0099</td><td>Out of service.</td><td><div lang=\"ja\">APIがメンテナンス中、またはご利用できません。</div><div lang=\"en\">API is under maintenance or not available to use.</div></td></tr> </tbody> </table> </div>
*
500 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0002</td><td>An internal error has occurred.</td><td><div lang=\"ja\">内部エラーが発生しました。再度操作を実行してください。 <br>もし、問題が解決しない場合は、お問い合わせページをご利用ください。</div><div lang=\"en\">An internal error has occurred. Please try again later. <br>If the problem continues, please contact the support team via Inquiry page for assistance. </div></td></tr> </tbody> </table> </div>
*
200 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0001</td><td>Invalid Request.</td><td><div lang=\"ja\">さまざまな要因が考えられます。<br>主な要因は、パラメータの値が不正か、誤りがあるためにオペレーションが完了できません。</div><div lang=\"en\">This error can result for a variety of reasons. <br>Typically because one of the parameter values in the request is wrong or invalid and the operation cannot be completed.</div></td></tr> <tr><td>R0001</td><td>Require.</td><td><div lang=\"ja\">必須です。</div><div lang=\"en\">It is missing required parameter.</div></td></tr> <tr><td>F0001</td><td>Invalid format.</td><td><div lang=\"ja\">値の形式が不正です。</div><div lang=\"en\">The value format is invalid.</div></td></tr> <tr><td>V0001</td><td>Invalid value.</td><td><div lang=\"ja\">値が無効です。</div><div lang=\"en\">The value is invalid.</div></td></tr> <tr><td>S0001</td><td>Invalid Status.</td><td><div lang=\"ja\">ステータスが無効です。</div><div lang=\"en\">The status is invalid.</div></td></tr> <tr><td>L0002</td><td>Over list size.</td><td><div lang=\"ja\">配列の要素数が上限値を超過しています。</div><div lang=\"en\">The number of elements in the array exceeds the upper limit.</div></td></tr> <tr><td>L0001</td><td>Lower list size.</td><td><div lang=\"ja\">配列の要素数が下限値を下回っています。</div><div lang=\"en\">The number of elements in the array is below the lower limit.</div></td></tr> <tr><td>D0001</td><td>Duplicate.</td><td><div lang=\"ja\">一意な値が重複しています。</div><div lang=\"en\">The unique value is duplicated.</div></td></tr> <tr><td>RL001</td><td>Invalid relation.</td><td><div lang=\"ja\">リクエストの関連性が矛盾しています。<br> たとえば、開始>終了の日付指定を行なっているなど</div><div lang=\"en\">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr> <tr><td>LT001</td><td>Over limit.</td><td><div lang=\"ja\">登録できる上限値を超過しています。</div><div lang=\"en\">The upper limit value that can be registered is exceeded.</div></td></tr> <tr><td>I0001</td><td>Deactivated Id.</td><td><div lang=\"ja\">IDが無効です。</div><div lang=\"en\">The ID is Deactivated.</div></td></tr> <tr><td>130000</td><td>The server is busy. Please retry later.</td><td><div lang=\"ja\">サーバーが高負荷です。時間をおいて再試行してください。</div><div lang=\"en\">The server is busy. Please retry later.</div></td></tr> <tr><td>130001</td><td>The request was not completed. Please reduce concurrent requests or data size. </td><td><div lang=\"ja\">リクエストが完了しませんでした。同時リクエスト数またはデータサイズを減らして再度お試しください。</div><div lang=\"en\">The request was not completed. Please reduce concurrent requests or data size.</div></td></tr> <tr><td>210405</td><td>Budget has exceeded.</td><td><div lang=\"ja\">予算額を超過しています。</div><div lang=\"en\">The budget amount is exceeded.</div></td></tr> <tr><td>210303</td><td>Invalid conversion tracking.</td><td><div lang=\"ja\">コンバージョントラッキングが無効です。</div><div lang=\"en\">Conversion tracking is Invalid.</div></td></tr> <tr><td>210301</td><td>Setting the disabled Auto bidding.</td><td><div lang=\"ja\">編集中(削除含む)の自動入札を指定しています。</div><div lang=\"en\">Auto bidding in editing (including deletion) is specified.</div></td></tr> <tr><td>210304</td><td>Not enough conversions or invalid setting.</td><td><div lang=\"ja\">コンバージョン数が不十分です。</div><div lang=\"en\">Conversions is not enough.</div></td></tr> <tr><td>210305</td><td>Auto bidding is already set.</td><td><div lang=\"ja\">キーワードに個別の入札価格や入札設定が指定されている状態で、キャンペーンに「コンバージョン数の最大化」、または「コンバージョン単価の目標値」の自動入札を設定しております。</div><div lang=\"en\">Auto bidding of \"Enhanced CPC\" or \"Target conversion spend\" is set for campaigns with individual bidding prices and bidding settings specified for keywords.</div></td></tr> <tr><td>210306</td><td>Cannot use conversion optimizer.</td><td><div lang=\"ja\">コンバージョンオプティマイザーが利用できません。</div><div lang=\"en\">Conversion optimizer cannot be used.</div></td></tr> <tr><td>210308</td><td>Set campaign active.</td><td><div lang=\"ja\">キャンペーンがACTIVEでないため、入札設定が利用できません。</div><div lang=\"en\">Since the campaign is not ACTIVE, the bidding settings can not be used.</div></td></tr> <tr><td>210309</td><td>Set campaign to CPC.</td><td><div lang=\"ja\">キャンペーンが「CPC」でないため、入札設定が利用できません。</div><div lang=\"en\">Since the campaign is not \"CPC\", bidding settings can not be used.</div></td></tr> <tr><td>210409</td><td>AdGroupServiceBid setting limit has exceed.</td><td><div lang=\"ja\">キャンペーン配下の広告広告グループに設定した入札金額または自動入札設定数が上限を超えています。<br>※1キャンペーンに設定できる入札金額および自動入札設定は、配下の広告グループ合計で1000件までです。</div><div lang=\"en\">The bid amount or Auto bidding number set for the ad / ad group under the campaign exceeds the maximum limit. <br> * 1 The maximum bid amount and Auto bidding setting that can be set for the campaign is 1000 in total for the ad group below.</div></td></tr> <tr><td>211000</td><td>Cannot operate AdvancedURL(FinalURL).</td><td><div lang=\"ja\">アドバンスドURLに移行済みのため、操作できません。</div><div lang=\"en\">Since it has already been transferred to AdvancedURL(FinalURL), it can not be operated.</div></td></tr> <tr><td>211001</td><td>Cannot set AdvancedMobileURL(SmartphoneFinalURL).</td><td><div lang=\"ja\">アプリダウンロードキャンペーンでは、advancedMobileURL(smartphoneFinalURL)の設定はできません。</div><div lang=\"en\">In the app download campaign, AdvancedMobileURL(SmartphoneFinalURL) can not be set.</div></td></tr> <tr><td>211003</td><td>Domain does not match with DisplayURL.</td><td><div lang=\"ja\">表示URLと最終リンク先URLのドメインが一致していません。</div><div lang=\"en\">Domain of DisplayURL and FinalUrl do not match.</div></td></tr> <tr><td>211004</td><td>Cannot set under AndroidCampaign.</td><td><div lang=\"ja\">Androidのアプリキャンペーンでは、以下の設定ができません:<br>・キャンペーン、広告グループ、広告、キーワードにTrackingUrlや CustomParameterを設定<br>・キーワードに最終リンク先URLやスマートフォン向けURLを設定</div><div lang=\"en\">In the Android app campaign, the following settings can not be made:<br>・Set TrackingUrl and CustomParameter for campaigns, ad groups, ads, keywords<br>・Set the AdvancedUrl(FinalUrl) and AdvancedMobileUrl(SmartphoneFinalUrl) for the keywords</div></td></tr> </tbody> </table> </div>
*
403 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0098</td><td>Permission denied.</td><td><div lang=\"ja\">権限がありません。</div><div lang=\"en\">Permission denied.</div></td></tr> <tr><td>0003</td><td>Frequency limit exceeded. Please try your request again later</td><td><div lang=\"ja\">アクセス頻度が上限値に達しました。時間をおいて再度実行してください。</div><div lang=\"en\">Frequency limit exceeded. Please try your request again later.</div></td></tr> </tbody> </table> </div>
*
401 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0110</td><td>Require access token.</td><td><div lang=\"ja\">アクセストークンがリクエストヘッダに存在していません。</div><div lang=\"en\">There is no access token in the request header.</div></td></tr> <tr><td>0111</td><td>Authentication failed.</td><td><div lang=\"ja\">アクセストークンの認証に失敗しました。</div><div lang=\"en\">The access token authentication failed.</div></td></tr> <tr><td>0112</td><td>Account not found.</td><td><div lang=\"ja\">アカウントが見つかりませんでした。</div><div lang=\"en\">The account can not found.</div></td></tr> <tr><td>0113</td><td>Deactivated account.</td><td><div lang=\"ja\">アカウントが無効です。</div><div lang=\"en\">The account is deactivated.</div></td></tr> </tbody> </table> </div>
*
400 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0114</td><td>Invalid scope.</td><td><div lang=\"ja\">アクセストークンが無効です。</div><div lang=\"en\">The access token is invalid.</div></td></tr> </tbody> </table> </div>
* @param xZBaseAccountId <div lang=\"ja\">アカウントIDを指定してください。</div> <div lang=\"en\">Specify Account ID.</div> (required)
* @param adGroupServiceOperation (optional)
* @return ResponseEntity<AdGroupServiceMutateResponse>
* @throws RestClientException if an error occurs while attempting to invoke the API
*/
public ResponseEntity adGroupServiceAddPostWithHttpInfo(Long xZBaseAccountId, AdGroupServiceOperation adGroupServiceOperation) throws RestClientException {
Object postBody = adGroupServiceOperation;
// verify the required parameter 'xZBaseAccountId' is set
if (xZBaseAccountId == null) {
throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'xZBaseAccountId' when calling adGroupServiceAddPost");
}
final MultiValueMap queryParams = new LinkedMultiValueMap();
final HttpHeaders headerParams = new HttpHeaders();
final MultiValueMap cookieParams = new LinkedMultiValueMap();
final MultiValueMap formParams = new LinkedMultiValueMap();
if (xZBaseAccountId != null)
headerParams.add("x-z-base-account-id", apiClient.parameterToString(xZBaseAccountId));
final String[] localVarAccepts = {
"application/json"
};
final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] contentTypes = {
"application/json"
};
final MediaType localVarContentType = apiClient.selectHeaderContentType(contentTypes);
String[] authNames = new String[] { "oAuth" };
ParameterizedTypeReference returnType = new ParameterizedTypeReference() {};
return apiClient.invokeAPI("/AdGroupService/add", HttpMethod.POST, Collections.emptyMap(), queryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, authNames, returnType);
}
/**
*
* <div lang=\"ja\">広告グループに関する情報を取得します。</div> <div lang=\"en\">Gets Ad group information.</div>
* 503 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0099</td><td>Out of service.</td><td><div lang=\"ja\">APIがメンテナンス中、またはご利用できません。</div><div lang=\"en\">API is under maintenance or not available to use.</div></td></tr> </tbody> </table> </div>
*
500 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0002</td><td>An internal error has occurred.</td><td><div lang=\"ja\">内部エラーが発生しました。再度操作を実行してください。 <br>もし、問題が解決しない場合は、お問い合わせページをご利用ください。</div><div lang=\"en\">An internal error has occurred. Please try again later. <br>If the problem continues, please contact the support team via Inquiry page for assistance. </div></td></tr> </tbody> </table> </div>
*
200 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0001</td><td>Invalid Request.</td><td><div lang=\"ja\">さまざまな要因が考えられます。<br>主な要因は、パラメータの値が不正か、誤りがあるためにオペレーションが完了できません。</div><div lang=\"en\">This error can result for a variety of reasons. <br>Typically because one of the parameter values in the request is wrong or invalid and the operation cannot be completed.</div></td></tr> <tr><td>R0001</td><td>Require.</td><td><div lang=\"ja\">必須です。</div><div lang=\"en\">It is missing required parameter.</div></td></tr> <tr><td>F0001</td><td>Invalid format.</td><td><div lang=\"ja\">値の形式が不正です。</div><div lang=\"en\">The value format is invalid.</div></td></tr> <tr><td>V0001</td><td>Invalid value.</td><td><div lang=\"ja\">値が無効です。</div><div lang=\"en\">The value is invalid.</div></td></tr> <tr><td>S0001</td><td>Invalid Status.</td><td><div lang=\"ja\">ステータスが無効です。</div><div lang=\"en\">The status is invalid.</div></td></tr> <tr><td>L0002</td><td>Over list size.</td><td><div lang=\"ja\">配列の要素数が上限値を超過しています。</div><div lang=\"en\">The number of elements in the array exceeds the upper limit.</div></td></tr> <tr><td>L0001</td><td>Lower list size.</td><td><div lang=\"ja\">配列の要素数が下限値を下回っています。</div><div lang=\"en\">The number of elements in the array is below the lower limit.</div></td></tr> <tr><td>D0001</td><td>Duplicate.</td><td><div lang=\"ja\">一意な値が重複しています。</div><div lang=\"en\">The unique value is duplicated.</div></td></tr> <tr><td>RL001</td><td>Invalid relation.</td><td><div lang=\"ja\">リクエストの関連性が矛盾しています。<br> たとえば、開始>終了の日付指定を行なっているなど</div><div lang=\"en\">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr> <tr><td>LT001</td><td>Over limit.</td><td><div lang=\"ja\">登録できる上限値を超過しています。</div><div lang=\"en\">The upper limit value that can be registered is exceeded.</div></td></tr> <tr><td>I0001</td><td>Deactivated Id.</td><td><div lang=\"ja\">IDが無効です。</div><div lang=\"en\">The ID is Deactivated.</div></td></tr> <tr><td>210405</td><td>Budget has exceeded.</td><td><div lang=\"ja\">予算額を超過しています。</div><div lang=\"en\">The budget amount is exceeded.</div></td></tr> <tr><td>210303</td><td>Invalid conversion tracking.</td><td><div lang=\"ja\">コンバージョントラッキングが無効です。</div><div lang=\"en\">Conversion tracking is Invalid.</div></td></tr> <tr><td>210301</td><td>Setting the disabled Auto bidding.</td><td><div lang=\"ja\">編集中(削除含む)の自動入札を指定しています。</div><div lang=\"en\">Auto bidding in editing (including deletion) is specified.</div></td></tr> <tr><td>210304</td><td>Not enough conversions or invalid setting.</td><td><div lang=\"ja\">コンバージョン数が不十分です。</div><div lang=\"en\">Conversions is not enough.</div></td></tr> <tr><td>210305</td><td>Auto bidding is already set.</td><td><div lang=\"ja\">キーワードに個別の入札価格や入札設定が指定されている状態で、キャンペーンに「コンバージョン数の最大化」、または「コンバージョン単価の目標値」の自動入札を設定しております。</div><div lang=\"en\">Auto bidding of \"Enhanced CPC\" or \"Target conversion spend\" is set for campaigns with individual bidding prices and bidding settings specified for keywords.</div></td></tr> <tr><td>210306</td><td>Cannot use conversion optimizer.</td><td><div lang=\"ja\">コンバージョンオプティマイザーが利用できません。</div><div lang=\"en\">Conversion optimizer cannot be used.</div></td></tr> <tr><td>210308</td><td>Set campaign active.</td><td><div lang=\"ja\">キャンペーンがACTIVEでないため、入札設定が利用できません。</div><div lang=\"en\">Since the campaign is not ACTIVE, the bidding settings can not be used.</div></td></tr> <tr><td>210309</td><td>Set campaign to CPC.</td><td><div lang=\"ja\">キャンペーンが「CPC」でないため、入札設定が利用できません。</div><div lang=\"en\">Since the campaign is not \"CPC\", bidding settings can not be used.</div></td></tr> <tr><td>210409</td><td>AdGroupServiceBid setting limit has exceed.</td><td><div lang=\"ja\">キャンペーン配下の広告広告グループに設定した入札金額または自動入札設定数が上限を超えています。<br>※1キャンペーンに設定できる入札金額および自動入札設定は、配下の広告グループ合計で1000件までです。</div><div lang=\"en\">The bid amount or Auto bidding number set for the ad / ad group under the campaign exceeds the maximum limit. <br> * 1 The maximum bid amount and Auto bidding setting that can be set for the campaign is 1000 in total for the ad group below.</div></td></tr> <tr><td>211000</td><td>Cannot operate AdvancedURL(FinalURL).</td><td><div lang=\"ja\">アドバンスドURLに移行済みのため、操作できません。</div><div lang=\"en\">Since it has already been transferred to AdvancedURL(FinalURL), it can not be operated.</div></td></tr> <tr><td>211001</td><td>Cannot set AdvancedMobileURL(SmartphoneFinalURL).</td><td><div lang=\"ja\">アプリダウンロードキャンペーンでは、advancedMobileURL(smartphoneFinalURL)の設定はできません。</div><div lang=\"en\">In the app download campaign, AdvancedMobileURL(SmartphoneFinalURL) can not be set.</div></td></tr> <tr><td>211003</td><td>Domain does not match with DisplayURL.</td><td><div lang=\"ja\">表示URLと最終リンク先URLのドメインが一致していません。</div><div lang=\"en\">Domain of DisplayURL and AdvancedURL(FinalURL) do not match.</div></td></tr> <tr><td>211004</td><td>Cannot set under AndroidCampaign.</td><td><div lang=\"ja\">Androidのアプリキャンペーンでは、以下の設定ができません:<br>・キャンペーン、広告グループ、広告、キーワードにTrackingUrlや CustomParameterを設定<br>・キーワードに最終リンク先URLやスマートフォン向けURLを設定</div><div lang=\"en\">In the Android app campaign, the following settings can not be made:<br>・Set TrackingUrl and CustomParameter for campaigns, ad groups, ads, keywords<br>・Set the AdvancedUrl(FinalUrl) and AdvancedMobileUrl(SmartphoneFinalUrl) for the keywords</div></td></tr> </tbody> </table> </div>
*
403 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0098</td><td>Permission denied.</td><td><div lang=\"ja\">権限がありません。</div><div lang=\"en\">Permission denied.</div></td></tr> <tr><td>0003</td><td>Frequency limit exceeded. Please try your request again later</td><td><div lang=\"ja\">アクセス頻度が上限値に達しました。時間をおいて再度実行してください。</div><div lang=\"en\">Frequency limit exceeded. Please try your request again later.</div></td></tr> </tbody> </table> </div>
*
401 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0110</td><td>Require access token.</td><td><div lang=\"ja\">アクセストークンがリクエストヘッダに存在していません。</div><div lang=\"en\">There is no access token in the request header.</div></td></tr> <tr><td>0111</td><td>Authentication failed.</td><td><div lang=\"ja\">アクセストークンの認証に失敗しました。</div><div lang=\"en\">The access token authentication failed.</div></td></tr> <tr><td>0112</td><td>Account not found.</td><td><div lang=\"ja\">アカウントが見つかりませんでした。</div><div lang=\"en\">The account can not found.</div></td></tr> <tr><td>0113</td><td>Deactivated account.</td><td><div lang=\"ja\">アカウントが無効です。</div><div lang=\"en\">The account is deactivated.</div></td></tr> </tbody> </table> </div>
*
400 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0114</td><td>Invalid scope.</td><td><div lang=\"ja\">アクセストークンが無効です。</div><div lang=\"en\">The access token is invalid.</div></td></tr> </tbody> </table> </div>
* @param xZBaseAccountId <div lang=\"ja\">アカウントIDを指定してください。</div> <div lang=\"en\">Specify Account ID.</div> (required)
* @param adGroupServiceSelector (optional)
* @return AdGroupServiceGetResponse
* @throws RestClientException if an error occurs while attempting to invoke the API
*/
public AdGroupServiceGetResponse adGroupServiceGetPost(Long xZBaseAccountId, AdGroupServiceSelector adGroupServiceSelector) throws RestClientException {
return adGroupServiceGetPostWithHttpInfo(xZBaseAccountId, adGroupServiceSelector).getBody();
}
/**
*
* <div lang=\"ja\">広告グループに関する情報を取得します。</div> <div lang=\"en\">Gets Ad group information.</div>
*
503 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0099</td><td>Out of service.</td><td><div lang=\"ja\">APIがメンテナンス中、またはご利用できません。</div><div lang=\"en\">API is under maintenance or not available to use.</div></td></tr> </tbody> </table> </div>
*
500 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0002</td><td>An internal error has occurred.</td><td><div lang=\"ja\">内部エラーが発生しました。再度操作を実行してください。 <br>もし、問題が解決しない場合は、お問い合わせページをご利用ください。</div><div lang=\"en\">An internal error has occurred. Please try again later. <br>If the problem continues, please contact the support team via Inquiry page for assistance. </div></td></tr> </tbody> </table> </div>
*
200 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0001</td><td>Invalid Request.</td><td><div lang=\"ja\">さまざまな要因が考えられます。<br>主な要因は、パラメータの値が不正か、誤りがあるためにオペレーションが完了できません。</div><div lang=\"en\">This error can result for a variety of reasons. <br>Typically because one of the parameter values in the request is wrong or invalid and the operation cannot be completed.</div></td></tr> <tr><td>R0001</td><td>Require.</td><td><div lang=\"ja\">必須です。</div><div lang=\"en\">It is missing required parameter.</div></td></tr> <tr><td>F0001</td><td>Invalid format.</td><td><div lang=\"ja\">値の形式が不正です。</div><div lang=\"en\">The value format is invalid.</div></td></tr> <tr><td>V0001</td><td>Invalid value.</td><td><div lang=\"ja\">値が無効です。</div><div lang=\"en\">The value is invalid.</div></td></tr> <tr><td>S0001</td><td>Invalid Status.</td><td><div lang=\"ja\">ステータスが無効です。</div><div lang=\"en\">The status is invalid.</div></td></tr> <tr><td>L0002</td><td>Over list size.</td><td><div lang=\"ja\">配列の要素数が上限値を超過しています。</div><div lang=\"en\">The number of elements in the array exceeds the upper limit.</div></td></tr> <tr><td>L0001</td><td>Lower list size.</td><td><div lang=\"ja\">配列の要素数が下限値を下回っています。</div><div lang=\"en\">The number of elements in the array is below the lower limit.</div></td></tr> <tr><td>D0001</td><td>Duplicate.</td><td><div lang=\"ja\">一意な値が重複しています。</div><div lang=\"en\">The unique value is duplicated.</div></td></tr> <tr><td>RL001</td><td>Invalid relation.</td><td><div lang=\"ja\">リクエストの関連性が矛盾しています。<br> たとえば、開始>終了の日付指定を行なっているなど</div><div lang=\"en\">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr> <tr><td>LT001</td><td>Over limit.</td><td><div lang=\"ja\">登録できる上限値を超過しています。</div><div lang=\"en\">The upper limit value that can be registered is exceeded.</div></td></tr> <tr><td>I0001</td><td>Deactivated Id.</td><td><div lang=\"ja\">IDが無効です。</div><div lang=\"en\">The ID is Deactivated.</div></td></tr> <tr><td>210405</td><td>Budget has exceeded.</td><td><div lang=\"ja\">予算額を超過しています。</div><div lang=\"en\">The budget amount is exceeded.</div></td></tr> <tr><td>210303</td><td>Invalid conversion tracking.</td><td><div lang=\"ja\">コンバージョントラッキングが無効です。</div><div lang=\"en\">Conversion tracking is Invalid.</div></td></tr> <tr><td>210301</td><td>Setting the disabled Auto bidding.</td><td><div lang=\"ja\">編集中(削除含む)の自動入札を指定しています。</div><div lang=\"en\">Auto bidding in editing (including deletion) is specified.</div></td></tr> <tr><td>210304</td><td>Not enough conversions or invalid setting.</td><td><div lang=\"ja\">コンバージョン数が不十分です。</div><div lang=\"en\">Conversions is not enough.</div></td></tr> <tr><td>210305</td><td>Auto bidding is already set.</td><td><div lang=\"ja\">キーワードに個別の入札価格や入札設定が指定されている状態で、キャンペーンに「コンバージョン数の最大化」、または「コンバージョン単価の目標値」の自動入札を設定しております。</div><div lang=\"en\">Auto bidding of \"Enhanced CPC\" or \"Target conversion spend\" is set for campaigns with individual bidding prices and bidding settings specified for keywords.</div></td></tr> <tr><td>210306</td><td>Cannot use conversion optimizer.</td><td><div lang=\"ja\">コンバージョンオプティマイザーが利用できません。</div><div lang=\"en\">Conversion optimizer cannot be used.</div></td></tr> <tr><td>210308</td><td>Set campaign active.</td><td><div lang=\"ja\">キャンペーンがACTIVEでないため、入札設定が利用できません。</div><div lang=\"en\">Since the campaign is not ACTIVE, the bidding settings can not be used.</div></td></tr> <tr><td>210309</td><td>Set campaign to CPC.</td><td><div lang=\"ja\">キャンペーンが「CPC」でないため、入札設定が利用できません。</div><div lang=\"en\">Since the campaign is not \"CPC\", bidding settings can not be used.</div></td></tr> <tr><td>210409</td><td>AdGroupServiceBid setting limit has exceed.</td><td><div lang=\"ja\">キャンペーン配下の広告広告グループに設定した入札金額または自動入札設定数が上限を超えています。<br>※1キャンペーンに設定できる入札金額および自動入札設定は、配下の広告グループ合計で1000件までです。</div><div lang=\"en\">The bid amount or Auto bidding number set for the ad / ad group under the campaign exceeds the maximum limit. <br> * 1 The maximum bid amount and Auto bidding setting that can be set for the campaign is 1000 in total for the ad group below.</div></td></tr> <tr><td>211000</td><td>Cannot operate AdvancedURL(FinalURL).</td><td><div lang=\"ja\">アドバンスドURLに移行済みのため、操作できません。</div><div lang=\"en\">Since it has already been transferred to AdvancedURL(FinalURL), it can not be operated.</div></td></tr> <tr><td>211001</td><td>Cannot set AdvancedMobileURL(SmartphoneFinalURL).</td><td><div lang=\"ja\">アプリダウンロードキャンペーンでは、advancedMobileURL(smartphoneFinalURL)の設定はできません。</div><div lang=\"en\">In the app download campaign, AdvancedMobileURL(SmartphoneFinalURL) can not be set.</div></td></tr> <tr><td>211003</td><td>Domain does not match with DisplayURL.</td><td><div lang=\"ja\">表示URLと最終リンク先URLのドメインが一致していません。</div><div lang=\"en\">Domain of DisplayURL and AdvancedURL(FinalURL) do not match.</div></td></tr> <tr><td>211004</td><td>Cannot set under AndroidCampaign.</td><td><div lang=\"ja\">Androidのアプリキャンペーンでは、以下の設定ができません:<br>・キャンペーン、広告グループ、広告、キーワードにTrackingUrlや CustomParameterを設定<br>・キーワードに最終リンク先URLやスマートフォン向けURLを設定</div><div lang=\"en\">In the Android app campaign, the following settings can not be made:<br>・Set TrackingUrl and CustomParameter for campaigns, ad groups, ads, keywords<br>・Set the AdvancedUrl(FinalUrl) and AdvancedMobileUrl(SmartphoneFinalUrl) for the keywords</div></td></tr> </tbody> </table> </div>
*
403 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0098</td><td>Permission denied.</td><td><div lang=\"ja\">権限がありません。</div><div lang=\"en\">Permission denied.</div></td></tr> <tr><td>0003</td><td>Frequency limit exceeded. Please try your request again later</td><td><div lang=\"ja\">アクセス頻度が上限値に達しました。時間をおいて再度実行してください。</div><div lang=\"en\">Frequency limit exceeded. Please try your request again later.</div></td></tr> </tbody> </table> </div>
*
401 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0110</td><td>Require access token.</td><td><div lang=\"ja\">アクセストークンがリクエストヘッダに存在していません。</div><div lang=\"en\">There is no access token in the request header.</div></td></tr> <tr><td>0111</td><td>Authentication failed.</td><td><div lang=\"ja\">アクセストークンの認証に失敗しました。</div><div lang=\"en\">The access token authentication failed.</div></td></tr> <tr><td>0112</td><td>Account not found.</td><td><div lang=\"ja\">アカウントが見つかりませんでした。</div><div lang=\"en\">The account can not found.</div></td></tr> <tr><td>0113</td><td>Deactivated account.</td><td><div lang=\"ja\">アカウントが無効です。</div><div lang=\"en\">The account is deactivated.</div></td></tr> </tbody> </table> </div>
*
400 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0114</td><td>Invalid scope.</td><td><div lang=\"ja\">アクセストークンが無効です。</div><div lang=\"en\">The access token is invalid.</div></td></tr> </tbody> </table> </div>
* @param xZBaseAccountId <div lang=\"ja\">アカウントIDを指定してください。</div> <div lang=\"en\">Specify Account ID.</div> (required)
* @param adGroupServiceSelector (optional)
* @return ResponseEntity<AdGroupServiceGetResponse>
* @throws RestClientException if an error occurs while attempting to invoke the API
*/
public ResponseEntity adGroupServiceGetPostWithHttpInfo(Long xZBaseAccountId, AdGroupServiceSelector adGroupServiceSelector) throws RestClientException {
Object postBody = adGroupServiceSelector;
// verify the required parameter 'xZBaseAccountId' is set
if (xZBaseAccountId == null) {
throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'xZBaseAccountId' when calling adGroupServiceGetPost");
}
final MultiValueMap queryParams = new LinkedMultiValueMap();
final HttpHeaders headerParams = new HttpHeaders();
final MultiValueMap cookieParams = new LinkedMultiValueMap();
final MultiValueMap formParams = new LinkedMultiValueMap();
if (xZBaseAccountId != null)
headerParams.add("x-z-base-account-id", apiClient.parameterToString(xZBaseAccountId));
final String[] localVarAccepts = {
"application/json"
};
final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] contentTypes = {
"application/json"
};
final MediaType localVarContentType = apiClient.selectHeaderContentType(contentTypes);
String[] authNames = new String[] { "oAuth" };
ParameterizedTypeReference returnType = new ParameterizedTypeReference() {};
return apiClient.invokeAPI("/AdGroupService/get", HttpMethod.POST, Collections.emptyMap(), queryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, authNames, returnType);
}
/**
*
* <div lang=\"ja\">広告グループを削除します。</div> <div lang=\"en\">Removes Ad group information.</div>
* 503 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0099</td><td>Out of service.</td><td><div lang=\"ja\">APIがメンテナンス中、またはご利用できません。</div><div lang=\"en\">API is under maintenance or not available to use.</div></td></tr> </tbody> </table> </div>
*
500 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0002</td><td>An internal error has occurred.</td><td><div lang=\"ja\">内部エラーが発生しました。再度操作を実行してください。 <br>もし、問題が解決しない場合は、お問い合わせページをご利用ください。</div><div lang=\"en\">An internal error has occurred. Please try again later. <br>If the problem continues, please contact the support team via Inquiry page for assistance. </div></td></tr> </tbody> </table> </div>
*
200 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0001</td><td>Invalid Request.</td><td><div lang=\"ja\">さまざまな要因が考えられます。<br>主な要因は、パラメータの値が不正か、誤りがあるためにオペレーションが完了できません。</div><div lang=\"en\">This error can result for a variety of reasons. <br>Typically because one of the parameter values in the request is wrong or invalid and the operation cannot be completed.</div></td></tr> <tr><td>R0001</td><td>Require.</td><td><div lang=\"ja\">必須です。</div><div lang=\"en\">It is missing required parameter.</div></td></tr> <tr><td>F0001</td><td>Invalid format.</td><td><div lang=\"ja\">値の形式が不正です。</div><div lang=\"en\">The value format is invalid.</div></td></tr> <tr><td>V0001</td><td>Invalid value.</td><td><div lang=\"ja\">値が無効です。</div><div lang=\"en\">The value is invalid.</div></td></tr> <tr><td>S0001</td><td>Invalid Status.</td><td><div lang=\"ja\">ステータスが無効です。</div><div lang=\"en\">The status is invalid.</div></td></tr> <tr><td>L0002</td><td>Over list size.</td><td><div lang=\"ja\">配列の要素数が上限値を超過しています。</div><div lang=\"en\">The number of elements in the array exceeds the upper limit.</div></td></tr> <tr><td>L0001</td><td>Lower list size.</td><td><div lang=\"ja\">配列の要素数が下限値を下回っています。</div><div lang=\"en\">The number of elements in the array is below the lower limit.</div></td></tr> <tr><td>D0001</td><td>Duplicate.</td><td><div lang=\"ja\">一意な値が重複しています。</div><div lang=\"en\">The unique value is duplicated.</div></td></tr> <tr><td>RL001</td><td>Invalid relation.</td><td><div lang=\"ja\">リクエストの関連性が矛盾しています。<br> たとえば、開始>終了の日付指定を行なっているなど</div><div lang=\"en\">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr> <tr><td>LT001</td><td>Over limit.</td><td><div lang=\"ja\">登録できる上限値を超過しています。</div><div lang=\"en\">The upper limit value that can be registered is exceeded.</div></td></tr> <tr><td>I0001</td><td>Deactivated Id.</td><td><div lang=\"ja\">IDが無効です。</div><div lang=\"en\">The ID is Deactivated.</div></td></tr> <tr><td>130000</td><td>The server is busy. Please retry later.</td><td><div lang=\"ja\">サーバーが高負荷です。時間をおいて再試行してください。</div><div lang=\"en\">The server is busy. Please retry later.</div></td></tr> <tr><td>130001</td><td>The request was not completed. Please reduce concurrent requests or data size. </td><td><div lang=\"ja\">リクエストが完了しませんでした。同時リクエスト数またはデータサイズを減らして再度お試しください。</div><div lang=\"en\">The request was not completed. Please reduce concurrent requests or data size.</div></td></tr> <tr><td>210405</td><td>Budget has exceeded.</td><td><div lang=\"ja\">予算額を超過しています。</div><div lang=\"en\">The budget amount is exceeded.</div></td></tr> <tr><td>210303</td><td>Invalid conversion tracking.</td><td><div lang=\"ja\">コンバージョントラッキングが無効です。</div><div lang=\"en\">Conversion tracking is Invalid.</div></td></tr> <tr><td>210301</td><td>Setting the disabled Auto bidding.</td><td><div lang=\"ja\">編集中(削除含む)の自動入札を指定しています。</div><div lang=\"en\">Auto bidding in editing (including deletion) is specified.</div></td></tr> <tr><td>210304</td><td>Not enough conversions or invalid setting.</td><td><div lang=\"ja\">コンバージョン数が不十分です。</div><div lang=\"en\">Conversions is not enough.</div></td></tr> <tr><td>210305</td><td>Auto bidding is already set.</td><td><div lang=\"ja\">キーワードに個別の入札価格や入札設定が指定されている状態で、キャンペーンに「コンバージョン数の最大化」、または「コンバージョン単価の目標値」の自動入札を設定しております。</div><div lang=\"en\">Auto bidding of \"Enhanced CPC\" or \"Target conversion spend\" is set for campaigns with individual bidding prices and bidding settings specified for keywords.</div></td></tr> <tr><td>210306</td><td>Cannot use conversion optimizer.</td><td><div lang=\"ja\">コンバージョンオプティマイザーが利用できません。</div><div lang=\"en\">Conversion optimizer cannot be used.</div></td></tr> <tr><td>210308</td><td>Set campaign active.</td><td><div lang=\"ja\">キャンペーンがACTIVEでないため、入札設定が利用できません。</div><div lang=\"en\">Since the campaign is not ACTIVE, the bidding settings can not be used.</div></td></tr> <tr><td>210309</td><td>Set campaign to CPC.</td><td><div lang=\"ja\">キャンペーンが「CPC」でないため、入札設定が利用できません。</div><div lang=\"en\">Since the campaign is not \"CPC\", bidding settings can not be used.</div></td></tr> <tr><td>210409</td><td>AdGroupServiceBid setting limit has exceed.</td><td><div lang=\"ja\">キャンペーン配下の広告広告グループに設定した入札金額または自動入札設定数が上限を超えています。<br>※1キャンペーンに設定できる入札金額および自動入札設定は、配下の広告グループ合計で1000件までです。</div><div lang=\"en\">The bid amount or Auto bidding number set for the ad / ad group under the campaign exceeds the maximum limit. <br> * 1 The maximum bid amount and Auto bidding setting that can be set for the campaign is 1000 in total for the ad group below.</div></td></tr> <tr><td>211000</td><td>Cannot operate AdvancedURL(FinalURL).</td><td><div lang=\"ja\">アドバンスドURLに移行済みのため、操作できません。</div><div lang=\"en\">Since it has already been transferred to AdvancedURL(FinalURL), it can not be operated.</div></td></tr> <tr><td>211001</td><td>Cannot set AdvancedMobileURL(SmartphoneFinalURL).</td><td><div lang=\"ja\">アプリダウンロードキャンペーンでは、advancedMobileURL(smartphoneFinalURL)の設定はできません。</div><div lang=\"en\">In the app download campaign, AdvancedMobileURL(SmartphoneFinalURL) can not be set.</div></td></tr> <tr><td>211003</td><td>Domain does not match with DisplayURL.</td><td><div lang=\"ja\">表示URLと最終リンク先URLのドメインが一致していません。</div><div lang=\"en\">Domain of DisplayURL and AdvancedURL(FinalURL) do not match.</div></td></tr> <tr><td>211004</td><td>Cannot set under AndroidCampaign.</td><td><div lang=\"ja\">Androidのアプリキャンペーンでは、以下の設定ができません:<br>・キャンペーン、広告グループ、広告、キーワードにTrackingUrlや CustomParameterを設定<br>・キーワードに最終リンク先URLやスマートフォン向けURLを設定</div><div lang=\"en\">In the Android app campaign, the following settings can not be made:<br>・Set TrackingUrl and CustomParameter for campaigns, ad groups, ads, keywords<br>・Set the AdvancedUrl(FinalUrl) and AdvancedMobileUrl(SmartphoneFinalUrl) for the keywords</div></td></tr> </tbody> </table> </div>
*
403 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0098</td><td>Permission denied.</td><td><div lang=\"ja\">権限がありません。</div><div lang=\"en\">Permission denied.</div></td></tr> <tr><td>0003</td><td>Frequency limit exceeded. Please try your request again later</td><td><div lang=\"ja\">アクセス頻度が上限値に達しました。時間をおいて再度実行してください。</div><div lang=\"en\">Frequency limit exceeded. Please try your request again later.</div></td></tr> </tbody> </table> </div>
*
401 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0110</td><td>Require access token.</td><td><div lang=\"ja\">アクセストークンがリクエストヘッダに存在していません。</div><div lang=\"en\">There is no access token in the request header.</div></td></tr> <tr><td>0111</td><td>Authentication failed.</td><td><div lang=\"ja\">アクセストークンの認証に失敗しました。</div><div lang=\"en\">The access token authentication failed.</div></td></tr> <tr><td>0112</td><td>Account not found.</td><td><div lang=\"ja\">アカウントが見つかりませんでした。</div><div lang=\"en\">The account can not found.</div></td></tr> <tr><td>0113</td><td>Deactivated account.</td><td><div lang=\"ja\">アカウントが無効です。</div><div lang=\"en\">The account is deactivated.</div></td></tr> </tbody> </table> </div>
*
400 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0114</td><td>Invalid scope.</td><td><div lang=\"ja\">アクセストークンが無効です。</div><div lang=\"en\">The access token is invalid.</div></td></tr> </tbody> </table> </div>
* @param xZBaseAccountId <div lang=\"ja\">アカウントIDを指定してください。</div> <div lang=\"en\">Specify Account ID.</div> (required)
* @param adGroupServiceOperation (optional)
* @return AdGroupServiceMutateResponse
* @throws RestClientException if an error occurs while attempting to invoke the API
*/
public AdGroupServiceMutateResponse adGroupServiceRemovePost(Long xZBaseAccountId, AdGroupServiceOperation adGroupServiceOperation) throws RestClientException {
return adGroupServiceRemovePostWithHttpInfo(xZBaseAccountId, adGroupServiceOperation).getBody();
}
/**
*
* <div lang=\"ja\">広告グループを削除します。</div> <div lang=\"en\">Removes Ad group information.</div>
*
503 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0099</td><td>Out of service.</td><td><div lang=\"ja\">APIがメンテナンス中、またはご利用できません。</div><div lang=\"en\">API is under maintenance or not available to use.</div></td></tr> </tbody> </table> </div>
*
500 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0002</td><td>An internal error has occurred.</td><td><div lang=\"ja\">内部エラーが発生しました。再度操作を実行してください。 <br>もし、問題が解決しない場合は、お問い合わせページをご利用ください。</div><div lang=\"en\">An internal error has occurred. Please try again later. <br>If the problem continues, please contact the support team via Inquiry page for assistance. </div></td></tr> </tbody> </table> </div>
*
200 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0001</td><td>Invalid Request.</td><td><div lang=\"ja\">さまざまな要因が考えられます。<br>主な要因は、パラメータの値が不正か、誤りがあるためにオペレーションが完了できません。</div><div lang=\"en\">This error can result for a variety of reasons. <br>Typically because one of the parameter values in the request is wrong or invalid and the operation cannot be completed.</div></td></tr> <tr><td>R0001</td><td>Require.</td><td><div lang=\"ja\">必須です。</div><div lang=\"en\">It is missing required parameter.</div></td></tr> <tr><td>F0001</td><td>Invalid format.</td><td><div lang=\"ja\">値の形式が不正です。</div><div lang=\"en\">The value format is invalid.</div></td></tr> <tr><td>V0001</td><td>Invalid value.</td><td><div lang=\"ja\">値が無効です。</div><div lang=\"en\">The value is invalid.</div></td></tr> <tr><td>S0001</td><td>Invalid Status.</td><td><div lang=\"ja\">ステータスが無効です。</div><div lang=\"en\">The status is invalid.</div></td></tr> <tr><td>L0002</td><td>Over list size.</td><td><div lang=\"ja\">配列の要素数が上限値を超過しています。</div><div lang=\"en\">The number of elements in the array exceeds the upper limit.</div></td></tr> <tr><td>L0001</td><td>Lower list size.</td><td><div lang=\"ja\">配列の要素数が下限値を下回っています。</div><div lang=\"en\">The number of elements in the array is below the lower limit.</div></td></tr> <tr><td>D0001</td><td>Duplicate.</td><td><div lang=\"ja\">一意な値が重複しています。</div><div lang=\"en\">The unique value is duplicated.</div></td></tr> <tr><td>RL001</td><td>Invalid relation.</td><td><div lang=\"ja\">リクエストの関連性が矛盾しています。<br> たとえば、開始>終了の日付指定を行なっているなど</div><div lang=\"en\">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr> <tr><td>LT001</td><td>Over limit.</td><td><div lang=\"ja\">登録できる上限値を超過しています。</div><div lang=\"en\">The upper limit value that can be registered is exceeded.</div></td></tr> <tr><td>I0001</td><td>Deactivated Id.</td><td><div lang=\"ja\">IDが無効です。</div><div lang=\"en\">The ID is Deactivated.</div></td></tr> <tr><td>130000</td><td>The server is busy. Please retry later.</td><td><div lang=\"ja\">サーバーが高負荷です。時間をおいて再試行してください。</div><div lang=\"en\">The server is busy. Please retry later.</div></td></tr> <tr><td>130001</td><td>The request was not completed. Please reduce concurrent requests or data size. </td><td><div lang=\"ja\">リクエストが完了しませんでした。同時リクエスト数またはデータサイズを減らして再度お試しください。</div><div lang=\"en\">The request was not completed. Please reduce concurrent requests or data size.</div></td></tr> <tr><td>210405</td><td>Budget has exceeded.</td><td><div lang=\"ja\">予算額を超過しています。</div><div lang=\"en\">The budget amount is exceeded.</div></td></tr> <tr><td>210303</td><td>Invalid conversion tracking.</td><td><div lang=\"ja\">コンバージョントラッキングが無効です。</div><div lang=\"en\">Conversion tracking is Invalid.</div></td></tr> <tr><td>210301</td><td>Setting the disabled Auto bidding.</td><td><div lang=\"ja\">編集中(削除含む)の自動入札を指定しています。</div><div lang=\"en\">Auto bidding in editing (including deletion) is specified.</div></td></tr> <tr><td>210304</td><td>Not enough conversions or invalid setting.</td><td><div lang=\"ja\">コンバージョン数が不十分です。</div><div lang=\"en\">Conversions is not enough.</div></td></tr> <tr><td>210305</td><td>Auto bidding is already set.</td><td><div lang=\"ja\">キーワードに個別の入札価格や入札設定が指定されている状態で、キャンペーンに「コンバージョン数の最大化」、または「コンバージョン単価の目標値」の自動入札を設定しております。</div><div lang=\"en\">Auto bidding of \"Enhanced CPC\" or \"Target conversion spend\" is set for campaigns with individual bidding prices and bidding settings specified for keywords.</div></td></tr> <tr><td>210306</td><td>Cannot use conversion optimizer.</td><td><div lang=\"ja\">コンバージョンオプティマイザーが利用できません。</div><div lang=\"en\">Conversion optimizer cannot be used.</div></td></tr> <tr><td>210308</td><td>Set campaign active.</td><td><div lang=\"ja\">キャンペーンがACTIVEでないため、入札設定が利用できません。</div><div lang=\"en\">Since the campaign is not ACTIVE, the bidding settings can not be used.</div></td></tr> <tr><td>210309</td><td>Set campaign to CPC.</td><td><div lang=\"ja\">キャンペーンが「CPC」でないため、入札設定が利用できません。</div><div lang=\"en\">Since the campaign is not \"CPC\", bidding settings can not be used.</div></td></tr> <tr><td>210409</td><td>AdGroupServiceBid setting limit has exceed.</td><td><div lang=\"ja\">キャンペーン配下の広告広告グループに設定した入札金額または自動入札設定数が上限を超えています。<br>※1キャンペーンに設定できる入札金額および自動入札設定は、配下の広告グループ合計で1000件までです。</div><div lang=\"en\">The bid amount or Auto bidding number set for the ad / ad group under the campaign exceeds the maximum limit. <br> * 1 The maximum bid amount and Auto bidding setting that can be set for the campaign is 1000 in total for the ad group below.</div></td></tr> <tr><td>211000</td><td>Cannot operate AdvancedURL(FinalURL).</td><td><div lang=\"ja\">アドバンスドURLに移行済みのため、操作できません。</div><div lang=\"en\">Since it has already been transferred to AdvancedURL(FinalURL), it can not be operated.</div></td></tr> <tr><td>211001</td><td>Cannot set AdvancedMobileURL(SmartphoneFinalURL).</td><td><div lang=\"ja\">アプリダウンロードキャンペーンでは、advancedMobileURL(smartphoneFinalURL)の設定はできません。</div><div lang=\"en\">In the app download campaign, AdvancedMobileURL(SmartphoneFinalURL) can not be set.</div></td></tr> <tr><td>211003</td><td>Domain does not match with DisplayURL.</td><td><div lang=\"ja\">表示URLと最終リンク先URLのドメインが一致していません。</div><div lang=\"en\">Domain of DisplayURL and AdvancedURL(FinalURL) do not match.</div></td></tr> <tr><td>211004</td><td>Cannot set under AndroidCampaign.</td><td><div lang=\"ja\">Androidのアプリキャンペーンでは、以下の設定ができません:<br>・キャンペーン、広告グループ、広告、キーワードにTrackingUrlや CustomParameterを設定<br>・キーワードに最終リンク先URLやスマートフォン向けURLを設定</div><div lang=\"en\">In the Android app campaign, the following settings can not be made:<br>・Set TrackingUrl and CustomParameter for campaigns, ad groups, ads, keywords<br>・Set the AdvancedUrl(FinalUrl) and AdvancedMobileUrl(SmartphoneFinalUrl) for the keywords</div></td></tr> </tbody> </table> </div>
*
403 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0098</td><td>Permission denied.</td><td><div lang=\"ja\">権限がありません。</div><div lang=\"en\">Permission denied.</div></td></tr> <tr><td>0003</td><td>Frequency limit exceeded. Please try your request again later</td><td><div lang=\"ja\">アクセス頻度が上限値に達しました。時間をおいて再度実行してください。</div><div lang=\"en\">Frequency limit exceeded. Please try your request again later.</div></td></tr> </tbody> </table> </div>
*
401 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0110</td><td>Require access token.</td><td><div lang=\"ja\">アクセストークンがリクエストヘッダに存在していません。</div><div lang=\"en\">There is no access token in the request header.</div></td></tr> <tr><td>0111</td><td>Authentication failed.</td><td><div lang=\"ja\">アクセストークンの認証に失敗しました。</div><div lang=\"en\">The access token authentication failed.</div></td></tr> <tr><td>0112</td><td>Account not found.</td><td><div lang=\"ja\">アカウントが見つかりませんでした。</div><div lang=\"en\">The account can not found.</div></td></tr> <tr><td>0113</td><td>Deactivated account.</td><td><div lang=\"ja\">アカウントが無効です。</div><div lang=\"en\">The account is deactivated.</div></td></tr> </tbody> </table> </div>
*
400 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0114</td><td>Invalid scope.</td><td><div lang=\"ja\">アクセストークンが無効です。</div><div lang=\"en\">The access token is invalid.</div></td></tr> </tbody> </table> </div>
* @param xZBaseAccountId <div lang=\"ja\">アカウントIDを指定してください。</div> <div lang=\"en\">Specify Account ID.</div> (required)
* @param adGroupServiceOperation (optional)
* @return ResponseEntity<AdGroupServiceMutateResponse>
* @throws RestClientException if an error occurs while attempting to invoke the API
*/
public ResponseEntity adGroupServiceRemovePostWithHttpInfo(Long xZBaseAccountId, AdGroupServiceOperation adGroupServiceOperation) throws RestClientException {
Object postBody = adGroupServiceOperation;
// verify the required parameter 'xZBaseAccountId' is set
if (xZBaseAccountId == null) {
throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'xZBaseAccountId' when calling adGroupServiceRemovePost");
}
final MultiValueMap queryParams = new LinkedMultiValueMap();
final HttpHeaders headerParams = new HttpHeaders();
final MultiValueMap cookieParams = new LinkedMultiValueMap();
final MultiValueMap formParams = new LinkedMultiValueMap();
if (xZBaseAccountId != null)
headerParams.add("x-z-base-account-id", apiClient.parameterToString(xZBaseAccountId));
final String[] localVarAccepts = {
"application/json"
};
final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] contentTypes = {
"application/json"
};
final MediaType localVarContentType = apiClient.selectHeaderContentType(contentTypes);
String[] authNames = new String[] { "oAuth" };
ParameterizedTypeReference returnType = new ParameterizedTypeReference() {};
return apiClient.invokeAPI("/AdGroupService/remove", HttpMethod.POST, Collections.emptyMap(), queryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, authNames, returnType);
}
/**
*
* <div lang=\"ja\">広告グループを更新します。</div> <div lang=\"en\">Updates Ad group information.</div>
* 503 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0099</td><td>Out of service.</td><td><div lang=\"ja\">APIがメンテナンス中、またはご利用できません。</div><div lang=\"en\">API is under maintenance or not available to use.</div></td></tr> </tbody> </table> </div>
*
500 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0002</td><td>An internal error has occurred.</td><td><div lang=\"ja\">内部エラーが発生しました。再度操作を実行してください。 <br>もし、問題が解決しない場合は、お問い合わせページをご利用ください。</div><div lang=\"en\">An internal error has occurred. Please try again later. <br>If the problem continues, please contact the support team via Inquiry page for assistance. </div></td></tr> </tbody> </table> </div>
*
200 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0001</td><td>Invalid Request.</td><td><div lang=\"ja\">さまざまな要因が考えられます。<br>主な要因は、パラメータの値が不正か、誤りがあるためにオペレーションが完了できません。</div><div lang=\"en\">This error can result for a variety of reasons. <br>Typically because one of the parameter values in the request is wrong or invalid and the operation cannot be completed.</div></td></tr> <tr><td>R0001</td><td>Require.</td><td><div lang=\"ja\">必須です。</div><div lang=\"en\">It is missing required parameter.</div></td></tr> <tr><td>F0001</td><td>Invalid format.</td><td><div lang=\"ja\">値の形式が不正です。</div><div lang=\"en\">The value format is invalid.</div></td></tr> <tr><td>V0001</td><td>Invalid value.</td><td><div lang=\"ja\">値が無効です。</div><div lang=\"en\">The value is invalid.</div></td></tr> <tr><td>S0001</td><td>Invalid Status.</td><td><div lang=\"ja\">ステータスが無効です。</div><div lang=\"en\">The status is invalid.</div></td></tr> <tr><td>L0002</td><td>Over list size.</td><td><div lang=\"ja\">配列の要素数が上限値を超過しています。</div><div lang=\"en\">The number of elements in the array exceeds the upper limit.</div></td></tr> <tr><td>L0001</td><td>Lower list size.</td><td><div lang=\"ja\">配列の要素数が下限値を下回っています。</div><div lang=\"en\">The number of elements in the array is below the lower limit.</div></td></tr> <tr><td>D0001</td><td>Duplicate.</td><td><div lang=\"ja\">一意な値が重複しています。</div><div lang=\"en\">The unique value is duplicated.</div></td></tr> <tr><td>RL001</td><td>Invalid relation.</td><td><div lang=\"ja\">リクエストの関連性が矛盾しています。<br> たとえば、開始>終了の日付指定を行なっているなど</div><div lang=\"en\">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr> <tr><td>LT001</td><td>Over limit.</td><td><div lang=\"ja\">登録できる上限値を超過しています。</div><div lang=\"en\">The upper limit value that can be registered is exceeded.</div></td></tr> <tr><td>I0001</td><td>Deactivated Id.</td><td><div lang=\"ja\">IDが無効です。</div><div lang=\"en\">The ID is Deactivated.</div></td></tr> <tr><td>210405</td><td>Budget has exceeded.</td><td><div lang=\"ja\">予算額を超過しています。</div><div lang=\"en\">The budget amount is exceeded.</div></td></tr> <tr><td>130000</td><td>The server is busy. Please retry later.</td><td><div lang=\"ja\">サーバーが高負荷です。時間をおいて再試行してください。</div><div lang=\"en\">The server is busy. Please retry later.</div></td></tr> <tr><td>130001</td><td>The request was not completed. Please reduce concurrent requests or data size. </td><td><div lang=\"ja\">リクエストが完了しませんでした。同時リクエスト数またはデータサイズを減らして再度お試しください。</div><div lang=\"en\">The request was not completed. Please reduce concurrent requests or data size.</div></td></tr> <tr><td>210303</td><td>Invalid conversion tracking.</td><td><div lang=\"ja\">コンバージョントラッキングが無効です。</div><div lang=\"en\">Conversion tracking is Invalid.</div></td></tr> <tr><td>210301</td><td>Setting the disabled Auto bidding.</td><td><div lang=\"ja\">編集中(削除含む)の自動入札を指定しています。</div><div lang=\"en\">Auto bidding in editing (including deletion) is specified.</div></td></tr> <tr><td>210304</td><td>Not enough conversions or invalid setting.</td><td><div lang=\"ja\">コンバージョン数が不十分です。</div><div lang=\"en\">Conversions is not enough.</div></td></tr> <tr><td>210305</td><td>Auto bidding is already set.</td><td><div lang=\"ja\">キーワードに個別の入札価格や入札設定が指定されている状態で、キャンペーンに「コンバージョン数の最大化」、または「コンバージョン単価の目標値」の自動入札を設定しております。</div><div lang=\"en\">Auto bidding of \"Enhanced CPC\" or \"Target conversion spend\" is set for campaigns with individual bidding prices and bidding settings specified for keywords.</div></td></tr> <tr><td>210306</td><td>Cannot use conversion optimizer.</td><td><div lang=\"ja\">コンバージョンオプティマイザーが利用できません。</div><div lang=\"en\">Conversion optimizer cannot be used.</div></td></tr> <tr><td>210308</td><td>Set campaign active.</td><td><div lang=\"ja\">キャンペーンがACTIVEでないため、入札設定が利用できません。</div><div lang=\"en\">Since the campaign is not ACTIVE, the bidding settings can not be used.</div></td></tr> <tr><td>210309</td><td>Set campaign to CPC.</td><td><div lang=\"ja\">キャンペーンが「CPC」でないため、入札設定が利用できません。</div><div lang=\"en\">Since the campaign is not \"CPC\", bidding settings can not be used.</div></td></tr> <tr><td>210409</td><td>AdGroupServiceBid setting limit has exceed.</td><td><div lang=\"ja\">キャンペーン配下の広告広告グループに設定した入札金額または自動入札設定数が上限を超えています。<br>※1キャンペーンに設定できる入札金額および自動入札設定は、配下の広告グループ合計で1000件までです。</div><div lang=\"en\">The bid amount or Auto bidding number set for the ad / ad group under the campaign exceeds the maximum limit. <br> * 1 The maximum bid amount and Auto bidding setting that can be set for the campaign is 1000 in total for the ad group below.</div></td></tr> <tr><td>211000</td><td>Cannot operate AdvancedURL(FinalURL).</td><td><div lang=\"ja\">アドバンスドURLに移行済みのため、操作できません。</div><div lang=\"en\">Since it has already been transferred to AdvancedURL(FinalURL), it can not be operated.</div></td></tr> <tr><td>211001</td><td>Cannot set AdvancedMobileURL(SmartphoneFinalURL).</td><td><div lang=\"ja\">アプリダウンロードキャンペーンでは、advancedMobileURL(smartphoneFinalURL)の設定はできません。</div><div lang=\"en\">In the app download campaign, AdvancedMobileURL(SmartphoneFinalURL) can not be set.</div></td></tr> <tr><td>211003</td><td>Domain does not match with DisplayURL.</td><td><div lang=\"ja\">表示URLと最終リンク先URLのドメインが一致していません。</div><div lang=\"en\">Domain of DisplayURL and AdvancedURL(FinalURL) do not match.</div></td></tr> <tr><td>211004</td><td>Cannot set under AndroidCampaign.</td><td><div lang=\"ja\">Androidのアプリキャンペーンでは、以下の設定ができません:<br>・キャンペーン、広告グループ、広告、キーワードにTrackingUrlや CustomParameterを設定<br>・キーワードに最終リンク先URLやスマートフォン向けURLを設定</div><div lang=\"en\">In the Android app campaign, the following settings can not be made:<br>・Set TrackingUrl and CustomParameter for campaigns, ad groups, ads, keywords<br>・Set the AdvancedUrl(FinalUrl) and AdvancedMobileUrl(SmartphoneFinalUrl) for the keywords</div></td></tr> </tbody> </table> </div>
*
403 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0098</td><td>Permission denied.</td><td><div lang=\"ja\">権限がありません。</div><div lang=\"en\">Permission denied.</div></td></tr> <tr><td>0003</td><td>Frequency limit exceeded. Please try your request again later</td><td><div lang=\"ja\">アクセス頻度が上限値に達しました。時間をおいて再度実行してください。</div><div lang=\"en\">Frequency limit exceeded. Please try your request again later.</div></td></tr> </tbody> </table> </div>
*
401 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0110</td><td>Require access token.</td><td><div lang=\"ja\">アクセストークンがリクエストヘッダに存在していません。</div><div lang=\"en\">There is no access token in the request header.</div></td></tr> <tr><td>0111</td><td>Authentication failed.</td><td><div lang=\"ja\">アクセストークンの認証に失敗しました。</div><div lang=\"en\">The access token authentication failed.</div></td></tr> <tr><td>0112</td><td>Account not found.</td><td><div lang=\"ja\">アカウントが見つかりませんでした。</div><div lang=\"en\">The account can not found.</div></td></tr> <tr><td>0113</td><td>Deactivated account.</td><td><div lang=\"ja\">アカウントが無効です。</div><div lang=\"en\">The account is deactivated.</div></td></tr> </tbody> </table> </div>
*
400 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0114</td><td>Invalid scope.</td><td><div lang=\"ja\">アクセストークンが無効です。</div><div lang=\"en\">The access token is invalid.</div></td></tr> </tbody> </table> </div>
* @param xZBaseAccountId <div lang=\"ja\">アカウントIDを指定してください。</div> <div lang=\"en\">Specify Account ID.</div> (required)
* @param adGroupServiceOperation (optional)
* @return AdGroupServiceMutateResponse
* @throws RestClientException if an error occurs while attempting to invoke the API
*/
public AdGroupServiceMutateResponse adGroupServiceSetPost(Long xZBaseAccountId, AdGroupServiceOperation adGroupServiceOperation) throws RestClientException {
return adGroupServiceSetPostWithHttpInfo(xZBaseAccountId, adGroupServiceOperation).getBody();
}
/**
*
* <div lang=\"ja\">広告グループを更新します。</div> <div lang=\"en\">Updates Ad group information.</div>
*
503 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0099</td><td>Out of service.</td><td><div lang=\"ja\">APIがメンテナンス中、またはご利用できません。</div><div lang=\"en\">API is under maintenance or not available to use.</div></td></tr> </tbody> </table> </div>
*
500 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0002</td><td>An internal error has occurred.</td><td><div lang=\"ja\">内部エラーが発生しました。再度操作を実行してください。 <br>もし、問題が解決しない場合は、お問い合わせページをご利用ください。</div><div lang=\"en\">An internal error has occurred. Please try again later. <br>If the problem continues, please contact the support team via Inquiry page for assistance. </div></td></tr> </tbody> </table> </div>
*
200 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0001</td><td>Invalid Request.</td><td><div lang=\"ja\">さまざまな要因が考えられます。<br>主な要因は、パラメータの値が不正か、誤りがあるためにオペレーションが完了できません。</div><div lang=\"en\">This error can result for a variety of reasons. <br>Typically because one of the parameter values in the request is wrong or invalid and the operation cannot be completed.</div></td></tr> <tr><td>R0001</td><td>Require.</td><td><div lang=\"ja\">必須です。</div><div lang=\"en\">It is missing required parameter.</div></td></tr> <tr><td>F0001</td><td>Invalid format.</td><td><div lang=\"ja\">値の形式が不正です。</div><div lang=\"en\">The value format is invalid.</div></td></tr> <tr><td>V0001</td><td>Invalid value.</td><td><div lang=\"ja\">値が無効です。</div><div lang=\"en\">The value is invalid.</div></td></tr> <tr><td>S0001</td><td>Invalid Status.</td><td><div lang=\"ja\">ステータスが無効です。</div><div lang=\"en\">The status is invalid.</div></td></tr> <tr><td>L0002</td><td>Over list size.</td><td><div lang=\"ja\">配列の要素数が上限値を超過しています。</div><div lang=\"en\">The number of elements in the array exceeds the upper limit.</div></td></tr> <tr><td>L0001</td><td>Lower list size.</td><td><div lang=\"ja\">配列の要素数が下限値を下回っています。</div><div lang=\"en\">The number of elements in the array is below the lower limit.</div></td></tr> <tr><td>D0001</td><td>Duplicate.</td><td><div lang=\"ja\">一意な値が重複しています。</div><div lang=\"en\">The unique value is duplicated.</div></td></tr> <tr><td>RL001</td><td>Invalid relation.</td><td><div lang=\"ja\">リクエストの関連性が矛盾しています。<br> たとえば、開始>終了の日付指定を行なっているなど</div><div lang=\"en\">The relation of the request is contradictory.<br> For example, you are specifying the date of start > end.</div></td></tr> <tr><td>LT001</td><td>Over limit.</td><td><div lang=\"ja\">登録できる上限値を超過しています。</div><div lang=\"en\">The upper limit value that can be registered is exceeded.</div></td></tr> <tr><td>I0001</td><td>Deactivated Id.</td><td><div lang=\"ja\">IDが無効です。</div><div lang=\"en\">The ID is Deactivated.</div></td></tr> <tr><td>210405</td><td>Budget has exceeded.</td><td><div lang=\"ja\">予算額を超過しています。</div><div lang=\"en\">The budget amount is exceeded.</div></td></tr> <tr><td>130000</td><td>The server is busy. Please retry later.</td><td><div lang=\"ja\">サーバーが高負荷です。時間をおいて再試行してください。</div><div lang=\"en\">The server is busy. Please retry later.</div></td></tr> <tr><td>130001</td><td>The request was not completed. Please reduce concurrent requests or data size. </td><td><div lang=\"ja\">リクエストが完了しませんでした。同時リクエスト数またはデータサイズを減らして再度お試しください。</div><div lang=\"en\">The request was not completed. Please reduce concurrent requests or data size.</div></td></tr> <tr><td>210303</td><td>Invalid conversion tracking.</td><td><div lang=\"ja\">コンバージョントラッキングが無効です。</div><div lang=\"en\">Conversion tracking is Invalid.</div></td></tr> <tr><td>210301</td><td>Setting the disabled Auto bidding.</td><td><div lang=\"ja\">編集中(削除含む)の自動入札を指定しています。</div><div lang=\"en\">Auto bidding in editing (including deletion) is specified.</div></td></tr> <tr><td>210304</td><td>Not enough conversions or invalid setting.</td><td><div lang=\"ja\">コンバージョン数が不十分です。</div><div lang=\"en\">Conversions is not enough.</div></td></tr> <tr><td>210305</td><td>Auto bidding is already set.</td><td><div lang=\"ja\">キーワードに個別の入札価格や入札設定が指定されている状態で、キャンペーンに「コンバージョン数の最大化」、または「コンバージョン単価の目標値」の自動入札を設定しております。</div><div lang=\"en\">Auto bidding of \"Enhanced CPC\" or \"Target conversion spend\" is set for campaigns with individual bidding prices and bidding settings specified for keywords.</div></td></tr> <tr><td>210306</td><td>Cannot use conversion optimizer.</td><td><div lang=\"ja\">コンバージョンオプティマイザーが利用できません。</div><div lang=\"en\">Conversion optimizer cannot be used.</div></td></tr> <tr><td>210308</td><td>Set campaign active.</td><td><div lang=\"ja\">キャンペーンがACTIVEでないため、入札設定が利用できません。</div><div lang=\"en\">Since the campaign is not ACTIVE, the bidding settings can not be used.</div></td></tr> <tr><td>210309</td><td>Set campaign to CPC.</td><td><div lang=\"ja\">キャンペーンが「CPC」でないため、入札設定が利用できません。</div><div lang=\"en\">Since the campaign is not \"CPC\", bidding settings can not be used.</div></td></tr> <tr><td>210409</td><td>AdGroupServiceBid setting limit has exceed.</td><td><div lang=\"ja\">キャンペーン配下の広告広告グループに設定した入札金額または自動入札設定数が上限を超えています。<br>※1キャンペーンに設定できる入札金額および自動入札設定は、配下の広告グループ合計で1000件までです。</div><div lang=\"en\">The bid amount or Auto bidding number set for the ad / ad group under the campaign exceeds the maximum limit. <br> * 1 The maximum bid amount and Auto bidding setting that can be set for the campaign is 1000 in total for the ad group below.</div></td></tr> <tr><td>211000</td><td>Cannot operate AdvancedURL(FinalURL).</td><td><div lang=\"ja\">アドバンスドURLに移行済みのため、操作できません。</div><div lang=\"en\">Since it has already been transferred to AdvancedURL(FinalURL), it can not be operated.</div></td></tr> <tr><td>211001</td><td>Cannot set AdvancedMobileURL(SmartphoneFinalURL).</td><td><div lang=\"ja\">アプリダウンロードキャンペーンでは、advancedMobileURL(smartphoneFinalURL)の設定はできません。</div><div lang=\"en\">In the app download campaign, AdvancedMobileURL(SmartphoneFinalURL) can not be set.</div></td></tr> <tr><td>211003</td><td>Domain does not match with DisplayURL.</td><td><div lang=\"ja\">表示URLと最終リンク先URLのドメインが一致していません。</div><div lang=\"en\">Domain of DisplayURL and AdvancedURL(FinalURL) do not match.</div></td></tr> <tr><td>211004</td><td>Cannot set under AndroidCampaign.</td><td><div lang=\"ja\">Androidのアプリキャンペーンでは、以下の設定ができません:<br>・キャンペーン、広告グループ、広告、キーワードにTrackingUrlや CustomParameterを設定<br>・キーワードに最終リンク先URLやスマートフォン向けURLを設定</div><div lang=\"en\">In the Android app campaign, the following settings can not be made:<br>・Set TrackingUrl and CustomParameter for campaigns, ad groups, ads, keywords<br>・Set the AdvancedUrl(FinalUrl) and AdvancedMobileUrl(SmartphoneFinalUrl) for the keywords</div></td></tr> </tbody> </table> </div>
*
403 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0098</td><td>Permission denied.</td><td><div lang=\"ja\">権限がありません。</div><div lang=\"en\">Permission denied.</div></td></tr> <tr><td>0003</td><td>Frequency limit exceeded. Please try your request again later</td><td><div lang=\"ja\">アクセス頻度が上限値に達しました。時間をおいて再度実行してください。</div><div lang=\"en\">Frequency limit exceeded. Please try your request again later.</div></td></tr> </tbody> </table> </div>
*
401 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0110</td><td>Require access token.</td><td><div lang=\"ja\">アクセストークンがリクエストヘッダに存在していません。</div><div lang=\"en\">There is no access token in the request header.</div></td></tr> <tr><td>0111</td><td>Authentication failed.</td><td><div lang=\"ja\">アクセストークンの認証に失敗しました。</div><div lang=\"en\">The access token authentication failed.</div></td></tr> <tr><td>0112</td><td>Account not found.</td><td><div lang=\"ja\">アカウントが見つかりませんでした。</div><div lang=\"en\">The account can not found.</div></td></tr> <tr><td>0113</td><td>Deactivated account.</td><td><div lang=\"ja\">アカウントが無効です。</div><div lang=\"en\">The account is deactivated.</div></td></tr> </tbody> </table> </div>
*
400 - <p class=\"cellContent__head\">Error codes</p> <div class=\"cellContent__body\"> <table class=\"apiTable\"> <colgroup span=\"1\" class=\"short\"></colgroup> <colgroup span=\"2\"></colgroup> <thead> <tr><th>Code</th><th>Message</th><th>Description</th></tr> </thead> <tbody> <tr><td>0114</td><td>Invalid scope.</td><td><div lang=\"ja\">アクセストークンが無効です。</div><div lang=\"en\">The access token is invalid.</div></td></tr> </tbody> </table> </div>
* @param xZBaseAccountId <div lang=\"ja\">アカウントIDを指定してください。</div> <div lang=\"en\">Specify Account ID.</div> (required)
* @param adGroupServiceOperation (optional)
* @return ResponseEntity<AdGroupServiceMutateResponse>
* @throws RestClientException if an error occurs while attempting to invoke the API
*/
public ResponseEntity adGroupServiceSetPostWithHttpInfo(Long xZBaseAccountId, AdGroupServiceOperation adGroupServiceOperation) throws RestClientException {
Object postBody = adGroupServiceOperation;
// verify the required parameter 'xZBaseAccountId' is set
if (xZBaseAccountId == null) {
throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'xZBaseAccountId' when calling adGroupServiceSetPost");
}
final MultiValueMap queryParams = new LinkedMultiValueMap();
final HttpHeaders headerParams = new HttpHeaders();
final MultiValueMap cookieParams = new LinkedMultiValueMap();
final MultiValueMap formParams = new LinkedMultiValueMap();
if (xZBaseAccountId != null)
headerParams.add("x-z-base-account-id", apiClient.parameterToString(xZBaseAccountId));
final String[] localVarAccepts = {
"application/json"
};
final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] contentTypes = {
"application/json"
};
final MediaType localVarContentType = apiClient.selectHeaderContentType(contentTypes);
String[] authNames = new String[] { "oAuth" };
ParameterizedTypeReference returnType = new ParameterizedTypeReference() {};
return apiClient.invokeAPI("/AdGroupService/set", HttpMethod.POST, Collections.emptyMap(), queryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, authNames, returnType);
}
}