
jp.co.yahoo.adsdisplayapi.v14.api.AudienceListServiceApi Maven / Gradle / Ivy
Show all versions of ads-display-api-lib Show documentation
package jp.co.yahoo.adsdisplayapi.v14.api;
import jp.co.yahoo.adsdisplayapi.v14.ApiClient;
import jp.co.yahoo.adsdisplayapi.v14.model.AudienceListServiceGetResponse;
import jp.co.yahoo.adsdisplayapi.v14.model.AudienceListServiceGetUploadUserListResponse;
import jp.co.yahoo.adsdisplayapi.v14.model.AudienceListServiceMutateResponse;
import jp.co.yahoo.adsdisplayapi.v14.model.AudienceListServiceOperation;
import jp.co.yahoo.adsdisplayapi.v14.model.AudienceListServiceSelector;
import jp.co.yahoo.adsdisplayapi.v14.model.AudienceListServiceUploadUserListCompressType;
import jp.co.yahoo.adsdisplayapi.v14.model.AudienceListServiceUploadUserListResponse;
import jp.co.yahoo.adsdisplayapi.v14.model.AudienceListServiceUploadUserListStatusSelector;
import jp.co.yahoo.adsdisplayapi.v14.model.AudienceListServiceUploadUserListUploadType;
import java.io.File;
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.adsdisplayapi.v14.api.AudienceListServiceApi")
public class AudienceListServiceApi {
private ApiClient apiClient;
public AudienceListServiceApi() {
this(new ApiClient());
}
@Autowired
public AudienceListServiceApi(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 the audience list.</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>
*
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>
*
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>V0001</td><td>Invalid value.</td><td><div lang=\"ja\">値が無効です。</div><div lang=\"en\">The value is invalid.</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>F0001</td><td>Invalid format.</td><td><div lang=\"ja\">値の形式が不正です。</div><div lang=\"en\">The value format is invalid.</div></td></tr> <tr><td>110005</td><td>Not a valid id.</td><td><div lang=\"ja\">IDが有効ではありません。</div><div lang=\"en\">Not a valid id.</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>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>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>120020</td><td>Can not set value.</td><td><div lang=\"ja\">値を設定することができません。</div><div lang=\"en\">Value cannot be set.</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>210001</td><td>Selected value is not approved to update.</td><td><div lang=\"ja\">選択した内容は更新が許可されておりません。</div><div lang=\"en\">The selected elements is not approved to use for the updates of target list.</div></td></tr> <tr><td>210002</td><td>Cannot update from the dependency.</td><td><div lang=\"ja\">依存関係があるため、更新できません。</div><div lang=\"en\">Due to the dependency relations</div></td></tr> <tr><td>210003</td><td>A function is not permitted this account.</td><td><div lang=\"ja\">利用が許可されていないアカウントです。</div><div lang=\"en\">Custom audience is not available for this account.</div></td></tr> <tr><td>211005</td><td>Cannot remove shared audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループと紐づく共有リストは削除できません。</div><div lang=\"en\">Cannot remove shared audience list set to AdGroup.</div></td></tr> <tr><td>211006</td><td>Cannot set shared audience list as baseList.</td><td><div lang=\"ja\">共有リストをベースにした類似リストは作成できません。</div><div lang=\"en\">Cannot set shared audience list as baseList.</div></td></tr> <tr><td>211007</td><td>Cannot incorporate a non-shared list into a shared combination list.</td><td><div lang=\"ja\">共有されていないリストを共有されている組み合わせリストに組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a non-shared list into a shared combination list.</div></td></tr> <tr><td>211008</td><td>Cannot remove a audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループに紐づくオーディエンスリストは削除できません。</div><div lang=\"en\">Cannot remove a audience list set to AdGroup.</div></td></tr> <tr><td>211009</td><td>Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</td><td><div lang=\"ja\">組み合わせリストの所有者と異なる所有者の共有リストを組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</div></td></tr> <tr><td>211010</td><td>Cannot create a audience list.</td><td><div lang=\"ja\">サイトリターゲティングタグを未発行のためオーディエンスリストを作成できません。</div><div lang=\"en\">Audience list cannot be created because the site retargeting tag has not been issued.</div></td></tr> <tr><td>211011</td><td>Contain unavailable ad action user lists.</td><td><div lang=\"ja\">広告データ利用基準に抵触している広告アクションユーザーリストを用いて類似リストまたは組み合わせリストを作成することはできません。</div><div lang=\"en\">Cannot create a similarity list or a combination list using ad action user lists which are in violation of Advertising Data Usage Standards.</div></td></tr> <tr><td>211012</td><td>MCC account cannot create an ad action user list.</td><td><div lang=\"ja\">MCCアカウントで広告アクションユーザーリストを作成することはできません。</div><div lang=\"en\">MCC account cannot create an ad action user list.</div></td></tr> <tr><td>211013</td><td>Contain unavailable ads.</td><td><div lang=\"ja\">広告データ利用基準に抵触している広告を用いて広告アクションユーザーリストを作成できません。</div><div lang=\"en\">Cannot create an ad action user list using ads which are in violation of Advertising Data Usage Standards.</div></td></tr> <tr><td>211014</td><td>Contain Dynamic Ads for Display.</td><td><div lang=\"ja\">動的ディスプレイ広告を用いて広告アクションユーザーリストを作成できません。</div><div lang=\"en\">Cannot create an ad action user list using Dynamic Ads for Display.</div></td></tr> </tbody> </table> </div>
* @param xZBaseAccountId <div lang=\"ja\">アカウントIDを指定してください。</div> <div lang=\"en\">Specify Account ID.</div> (required)
* @param audienceListServiceOperation (optional)
* @return AudienceListServiceMutateResponse
* @throws RestClientException if an error occurs while attempting to invoke the API
*/
public AudienceListServiceMutateResponse audienceListServiceAddPost(Long xZBaseAccountId, AudienceListServiceOperation audienceListServiceOperation) throws RestClientException {
return audienceListServiceAddPostWithHttpInfo(xZBaseAccountId, audienceListServiceOperation).getBody();
}
/**
*
* <div lang=\"ja\">オーディエンスリストを作成します。</div> <div lang=\"en\">Create the audience list.</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>
*
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>
*
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>V0001</td><td>Invalid value.</td><td><div lang=\"ja\">値が無効です。</div><div lang=\"en\">The value is invalid.</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>F0001</td><td>Invalid format.</td><td><div lang=\"ja\">値の形式が不正です。</div><div lang=\"en\">The value format is invalid.</div></td></tr> <tr><td>110005</td><td>Not a valid id.</td><td><div lang=\"ja\">IDが有効ではありません。</div><div lang=\"en\">Not a valid id.</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>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>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>120020</td><td>Can not set value.</td><td><div lang=\"ja\">値を設定することができません。</div><div lang=\"en\">Value cannot be set.</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>210001</td><td>Selected value is not approved to update.</td><td><div lang=\"ja\">選択した内容は更新が許可されておりません。</div><div lang=\"en\">The selected elements is not approved to use for the updates of target list.</div></td></tr> <tr><td>210002</td><td>Cannot update from the dependency.</td><td><div lang=\"ja\">依存関係があるため、更新できません。</div><div lang=\"en\">Due to the dependency relations</div></td></tr> <tr><td>210003</td><td>A function is not permitted this account.</td><td><div lang=\"ja\">利用が許可されていないアカウントです。</div><div lang=\"en\">Custom audience is not available for this account.</div></td></tr> <tr><td>211005</td><td>Cannot remove shared audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループと紐づく共有リストは削除できません。</div><div lang=\"en\">Cannot remove shared audience list set to AdGroup.</div></td></tr> <tr><td>211006</td><td>Cannot set shared audience list as baseList.</td><td><div lang=\"ja\">共有リストをベースにした類似リストは作成できません。</div><div lang=\"en\">Cannot set shared audience list as baseList.</div></td></tr> <tr><td>211007</td><td>Cannot incorporate a non-shared list into a shared combination list.</td><td><div lang=\"ja\">共有されていないリストを共有されている組み合わせリストに組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a non-shared list into a shared combination list.</div></td></tr> <tr><td>211008</td><td>Cannot remove a audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループに紐づくオーディエンスリストは削除できません。</div><div lang=\"en\">Cannot remove a audience list set to AdGroup.</div></td></tr> <tr><td>211009</td><td>Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</td><td><div lang=\"ja\">組み合わせリストの所有者と異なる所有者の共有リストを組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</div></td></tr> <tr><td>211010</td><td>Cannot create a audience list.</td><td><div lang=\"ja\">サイトリターゲティングタグを未発行のためオーディエンスリストを作成できません。</div><div lang=\"en\">Audience list cannot be created because the site retargeting tag has not been issued.</div></td></tr> <tr><td>211011</td><td>Contain unavailable ad action user lists.</td><td><div lang=\"ja\">広告データ利用基準に抵触している広告アクションユーザーリストを用いて類似リストまたは組み合わせリストを作成することはできません。</div><div lang=\"en\">Cannot create a similarity list or a combination list using ad action user lists which are in violation of Advertising Data Usage Standards.</div></td></tr> <tr><td>211012</td><td>MCC account cannot create an ad action user list.</td><td><div lang=\"ja\">MCCアカウントで広告アクションユーザーリストを作成することはできません。</div><div lang=\"en\">MCC account cannot create an ad action user list.</div></td></tr> <tr><td>211013</td><td>Contain unavailable ads.</td><td><div lang=\"ja\">広告データ利用基準に抵触している広告を用いて広告アクションユーザーリストを作成できません。</div><div lang=\"en\">Cannot create an ad action user list using ads which are in violation of Advertising Data Usage Standards.</div></td></tr> <tr><td>211014</td><td>Contain Dynamic Ads for Display.</td><td><div lang=\"ja\">動的ディスプレイ広告を用いて広告アクションユーザーリストを作成できません。</div><div lang=\"en\">Cannot create an ad action user list using Dynamic Ads for Display.</div></td></tr> </tbody> </table> </div>
* @param xZBaseAccountId <div lang=\"ja\">アカウントIDを指定してください。</div> <div lang=\"en\">Specify Account ID.</div> (required)
* @param audienceListServiceOperation (optional)
* @return ResponseEntity<AudienceListServiceMutateResponse>
* @throws RestClientException if an error occurs while attempting to invoke the API
*/
public ResponseEntity audienceListServiceAddPostWithHttpInfo(Long xZBaseAccountId, AudienceListServiceOperation audienceListServiceOperation) throws RestClientException {
Object postBody = audienceListServiceOperation;
// verify the required parameter 'xZBaseAccountId' is set
if (xZBaseAccountId == null) {
throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'xZBaseAccountId' when calling audienceListServiceAddPost");
}
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("/AudienceListService/add", HttpMethod.POST, Collections.emptyMap(), queryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, authNames, returnType);
}
/**
*
* <div lang=\"ja\">オーディエンスリストを取得します。</div> <div lang=\"en\">Retrieve audience list 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>
*
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>
*
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>V0001</td><td>Invalid value.</td><td><div lang=\"ja\">値が無効です。</div><div lang=\"en\">The value is invalid.</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>F0001</td><td>Invalid format.</td><td><div lang=\"ja\">値の形式が不正です。</div><div lang=\"en\">The value format is invalid.</div></td></tr> <tr><td>110005</td><td>Not a valid id.</td><td><div lang=\"ja\">IDが有効ではありません。</div><div lang=\"en\">Not a valid id.</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>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>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>120020</td><td>Can not set value.</td><td><div lang=\"ja\">値を設定することができません。</div><div lang=\"en\">Value cannot be set.</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>210001</td><td>Selected value is not approved to update.</td><td><div lang=\"ja\">選択した内容は更新が許可されておりません。</div><div lang=\"en\">The selected elements is not approved to use for the updates of target list.</div></td></tr> <tr><td>210002</td><td>Cannot update from the dependency.</td><td><div lang=\"ja\">依存関係があるため、更新できません。</div><div lang=\"en\">Due to the dependency relations</div></td></tr> <tr><td>210003</td><td>A function is not permitted this account.</td><td><div lang=\"ja\">利用が許可されていないアカウントです。</div><div lang=\"en\">Custom audience is not available for this account.</div></td></tr> <tr><td>211005</td><td>Cannot remove shared audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループと紐づく共有リストは削除できません。</div><div lang=\"en\">Cannot remove shared audience list set to AdGroup.</div></td></tr> <tr><td>211006</td><td>Cannot set shared audience list as baseList.</td><td><div lang=\"ja\">共有リストをベースにした類似リストは作成できません。</div><div lang=\"en\">Cannot set shared audience list as baseList.</div></td></tr> <tr><td>211007</td><td>Cannot incorporate a non-shared list into a shared combination list.</td><td><div lang=\"ja\">共有されていないリストを共有されている組み合わせリストに組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a non-shared list into a shared combination list.</div></td></tr> <tr><td>211008</td><td>Cannot remove a audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループに紐づくオーディエンスリストは削除できません。</div><div lang=\"en\">Cannot remove a audience list set to AdGroup.</div></td></tr> <tr><td>211009</td><td>Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</td><td><div lang=\"ja\">組み合わせリストの所有者と異なる所有者の共有リストを組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</div></td></tr> </tbody> </table> </div>
* @param xZBaseAccountId <div lang=\"ja\">アカウントIDを指定してください。</div> <div lang=\"en\">Specify Account ID.</div> (required)
* @param audienceListServiceSelector (optional)
* @return AudienceListServiceGetResponse
* @throws RestClientException if an error occurs while attempting to invoke the API
*/
public AudienceListServiceGetResponse audienceListServiceGetPost(Long xZBaseAccountId, AudienceListServiceSelector audienceListServiceSelector) throws RestClientException {
return audienceListServiceGetPostWithHttpInfo(xZBaseAccountId, audienceListServiceSelector).getBody();
}
/**
*
* <div lang=\"ja\">オーディエンスリストを取得します。</div> <div lang=\"en\">Retrieve audience list 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>
*
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>
*
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>V0001</td><td>Invalid value.</td><td><div lang=\"ja\">値が無効です。</div><div lang=\"en\">The value is invalid.</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>F0001</td><td>Invalid format.</td><td><div lang=\"ja\">値の形式が不正です。</div><div lang=\"en\">The value format is invalid.</div></td></tr> <tr><td>110005</td><td>Not a valid id.</td><td><div lang=\"ja\">IDが有効ではありません。</div><div lang=\"en\">Not a valid id.</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>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>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>120020</td><td>Can not set value.</td><td><div lang=\"ja\">値を設定することができません。</div><div lang=\"en\">Value cannot be set.</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>210001</td><td>Selected value is not approved to update.</td><td><div lang=\"ja\">選択した内容は更新が許可されておりません。</div><div lang=\"en\">The selected elements is not approved to use for the updates of target list.</div></td></tr> <tr><td>210002</td><td>Cannot update from the dependency.</td><td><div lang=\"ja\">依存関係があるため、更新できません。</div><div lang=\"en\">Due to the dependency relations</div></td></tr> <tr><td>210003</td><td>A function is not permitted this account.</td><td><div lang=\"ja\">利用が許可されていないアカウントです。</div><div lang=\"en\">Custom audience is not available for this account.</div></td></tr> <tr><td>211005</td><td>Cannot remove shared audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループと紐づく共有リストは削除できません。</div><div lang=\"en\">Cannot remove shared audience list set to AdGroup.</div></td></tr> <tr><td>211006</td><td>Cannot set shared audience list as baseList.</td><td><div lang=\"ja\">共有リストをベースにした類似リストは作成できません。</div><div lang=\"en\">Cannot set shared audience list as baseList.</div></td></tr> <tr><td>211007</td><td>Cannot incorporate a non-shared list into a shared combination list.</td><td><div lang=\"ja\">共有されていないリストを共有されている組み合わせリストに組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a non-shared list into a shared combination list.</div></td></tr> <tr><td>211008</td><td>Cannot remove a audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループに紐づくオーディエンスリストは削除できません。</div><div lang=\"en\">Cannot remove a audience list set to AdGroup.</div></td></tr> <tr><td>211009</td><td>Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</td><td><div lang=\"ja\">組み合わせリストの所有者と異なる所有者の共有リストを組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</div></td></tr> </tbody> </table> </div>
* @param xZBaseAccountId <div lang=\"ja\">アカウントIDを指定してください。</div> <div lang=\"en\">Specify Account ID.</div> (required)
* @param audienceListServiceSelector (optional)
* @return ResponseEntity<AudienceListServiceGetResponse>
* @throws RestClientException if an error occurs while attempting to invoke the API
*/
public ResponseEntity audienceListServiceGetPostWithHttpInfo(Long xZBaseAccountId, AudienceListServiceSelector audienceListServiceSelector) throws RestClientException {
Object postBody = audienceListServiceSelector;
// verify the required parameter 'xZBaseAccountId' is set
if (xZBaseAccountId == null) {
throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'xZBaseAccountId' when calling audienceListServiceGetPost");
}
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("/AudienceListService/get", HttpMethod.POST, Collections.emptyMap(), queryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, authNames, returnType);
}
/**
*
* <div lang=\"ja\">ユーザリストのアップロード状況を取得します。</div> <div lang=\"en\">This acquires the upload status of the user list.</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>
*
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>
*
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>V0001</td><td>Invalid value.</td><td><div lang=\"ja\">値が無効です。</div><div lang=\"en\">The value is invalid.</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>F0001</td><td>Invalid format.</td><td><div lang=\"ja\">値の形式が不正です。</div><div lang=\"en\">The value format is invalid.</div></td></tr> <tr><td>110005</td><td>Not a valid id.</td><td><div lang=\"ja\">IDが有効ではありません。</div><div lang=\"en\">Not a valid id.</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>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>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>120020</td><td>Can not set value.</td><td><div lang=\"ja\">値を設定することができません。</div><div lang=\"en\">Value cannot be set.</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>210001</td><td>Selected value is not approved to update.</td><td><div lang=\"ja\">選択した内容は更新が許可されておりません。</div><div lang=\"en\">The selected elements is not approved to use for the updates of target list.</div></td></tr> <tr><td>210002</td><td>Cannot update from the dependency.</td><td><div lang=\"ja\">依存関係があるため、更新できません。</div><div lang=\"en\">Due to the dependency relations</div></td></tr> <tr><td>210003</td><td>A function is not permitted this account.</td><td><div lang=\"ja\">利用が許可されていないアカウントです。</div><div lang=\"en\">Custom audience is not available for this account.</div></td></tr> <tr><td>211005</td><td>Cannot remove shared audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループと紐づく共有リストは削除できません。</div><div lang=\"en\">Cannot remove shared audience list set to AdGroup.</div></td></tr> <tr><td>211006</td><td>Cannot set shared audience list as baseList.</td><td><div lang=\"ja\">共有リストをベースにした類似リストは作成できません。</div><div lang=\"en\">Cannot set shared audience list as baseList.</div></td></tr> <tr><td>211007</td><td>Cannot incorporate a non-shared list into a shared combination list.</td><td><div lang=\"ja\">共有されていないリストを共有されている組み合わせリストに組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a non-shared list into a shared combination list.</div></td></tr> <tr><td>211008</td><td>Cannot remove a audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループに紐づくオーディエンスリストは削除できません。</div><div lang=\"en\">Cannot remove a audience list set to AdGroup.</div></td></tr> <tr><td>211009</td><td>Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</td><td><div lang=\"ja\">組み合わせリストの所有者と異なる所有者の共有リストを組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</div></td></tr> </tbody> </table> </div>
* @param xZBaseAccountId <div lang=\"ja\">アカウントIDを指定してください。</div> <div lang=\"en\">Specify Account ID.</div> (required)
* @param audienceListServiceUploadUserListStatusSelector (optional)
* @return AudienceListServiceGetUploadUserListResponse
* @throws RestClientException if an error occurs while attempting to invoke the API
*/
public AudienceListServiceGetUploadUserListResponse audienceListServiceGetUploadUserListStatusPost(Long xZBaseAccountId, AudienceListServiceUploadUserListStatusSelector audienceListServiceUploadUserListStatusSelector) throws RestClientException {
return audienceListServiceGetUploadUserListStatusPostWithHttpInfo(xZBaseAccountId, audienceListServiceUploadUserListStatusSelector).getBody();
}
/**
*
* <div lang=\"ja\">ユーザリストのアップロード状況を取得します。</div> <div lang=\"en\">This acquires the upload status of the user list.</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>
*
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>
*
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>V0001</td><td>Invalid value.</td><td><div lang=\"ja\">値が無効です。</div><div lang=\"en\">The value is invalid.</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>F0001</td><td>Invalid format.</td><td><div lang=\"ja\">値の形式が不正です。</div><div lang=\"en\">The value format is invalid.</div></td></tr> <tr><td>110005</td><td>Not a valid id.</td><td><div lang=\"ja\">IDが有効ではありません。</div><div lang=\"en\">Not a valid id.</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>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>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>120020</td><td>Can not set value.</td><td><div lang=\"ja\">値を設定することができません。</div><div lang=\"en\">Value cannot be set.</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>210001</td><td>Selected value is not approved to update.</td><td><div lang=\"ja\">選択した内容は更新が許可されておりません。</div><div lang=\"en\">The selected elements is not approved to use for the updates of target list.</div></td></tr> <tr><td>210002</td><td>Cannot update from the dependency.</td><td><div lang=\"ja\">依存関係があるため、更新できません。</div><div lang=\"en\">Due to the dependency relations</div></td></tr> <tr><td>210003</td><td>A function is not permitted this account.</td><td><div lang=\"ja\">利用が許可されていないアカウントです。</div><div lang=\"en\">Custom audience is not available for this account.</div></td></tr> <tr><td>211005</td><td>Cannot remove shared audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループと紐づく共有リストは削除できません。</div><div lang=\"en\">Cannot remove shared audience list set to AdGroup.</div></td></tr> <tr><td>211006</td><td>Cannot set shared audience list as baseList.</td><td><div lang=\"ja\">共有リストをベースにした類似リストは作成できません。</div><div lang=\"en\">Cannot set shared audience list as baseList.</div></td></tr> <tr><td>211007</td><td>Cannot incorporate a non-shared list into a shared combination list.</td><td><div lang=\"ja\">共有されていないリストを共有されている組み合わせリストに組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a non-shared list into a shared combination list.</div></td></tr> <tr><td>211008</td><td>Cannot remove a audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループに紐づくオーディエンスリストは削除できません。</div><div lang=\"en\">Cannot remove a audience list set to AdGroup.</div></td></tr> <tr><td>211009</td><td>Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</td><td><div lang=\"ja\">組み合わせリストの所有者と異なる所有者の共有リストを組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</div></td></tr> </tbody> </table> </div>
* @param xZBaseAccountId <div lang=\"ja\">アカウントIDを指定してください。</div> <div lang=\"en\">Specify Account ID.</div> (required)
* @param audienceListServiceUploadUserListStatusSelector (optional)
* @return ResponseEntity<AudienceListServiceGetUploadUserListResponse>
* @throws RestClientException if an error occurs while attempting to invoke the API
*/
public ResponseEntity audienceListServiceGetUploadUserListStatusPostWithHttpInfo(Long xZBaseAccountId, AudienceListServiceUploadUserListStatusSelector audienceListServiceUploadUserListStatusSelector) throws RestClientException {
Object postBody = audienceListServiceUploadUserListStatusSelector;
// verify the required parameter 'xZBaseAccountId' is set
if (xZBaseAccountId == null) {
throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'xZBaseAccountId' when calling audienceListServiceGetUploadUserListStatusPost");
}
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("/AudienceListService/getUploadUserListStatus", HttpMethod.POST, Collections.emptyMap(), queryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, authNames, returnType);
}
/**
*
* <div lang=\"ja\">オーディエンスリストを削除します。</div> <div lang=\"en\">Deletes audience list.</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>
*
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>
*
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>V0001</td><td>Invalid value.</td><td><div lang=\"ja\">値が無効です。</div><div lang=\"en\">The value is invalid.</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>F0001</td><td>Invalid format.</td><td><div lang=\"ja\">値の形式が不正です。</div><div lang=\"en\">The value format is invalid.</div></td></tr> <tr><td>110005</td><td>Not a valid id.</td><td><div lang=\"ja\">IDが有効ではありません。</div><div lang=\"en\">Not a valid id.</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>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>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>120020</td><td>Can not set value.</td><td><div lang=\"ja\">値を設定することができません。</div><div lang=\"en\">Value cannot be set.</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>210001</td><td>Selected value is not approved to update.</td><td><div lang=\"ja\">選択した内容は更新が許可されておりません。</div><div lang=\"en\">The selected elements is not approved to use for the updates of target list.</div></td></tr> <tr><td>210002</td><td>Cannot update from the dependency.</td><td><div lang=\"ja\">依存関係があるため、更新できません。</div><div lang=\"en\">Due to the dependency relations</div></td></tr> <tr><td>210003</td><td>A function is not permitted this account.</td><td><div lang=\"ja\">利用が許可されていないアカウントです。</div><div lang=\"en\">Custom audience is not available for this account.</div></td></tr> <tr><td>211005</td><td>Cannot remove shared audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループと紐づく共有リストは削除できません。</div><div lang=\"en\">Cannot remove shared audience list set to AdGroup.</div></td></tr> <tr><td>211006</td><td>Cannot set shared audience list as baseList.</td><td><div lang=\"ja\">共有リストをベースにした類似リストは作成できません。</div><div lang=\"en\">Cannot set shared audience list as baseList.</div></td></tr> <tr><td>211007</td><td>Cannot incorporate a non-shared list into a shared combination list.</td><td><div lang=\"ja\">共有されていないリストを共有されている組み合わせリストに組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a non-shared list into a shared combination list.</div></td></tr> <tr><td>211008</td><td>Cannot remove a audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループに紐づくオーディエンスリストは削除できません。</div><div lang=\"en\">Cannot remove a audience list set to AdGroup.</div></td></tr> <tr><td>211009</td><td>Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</td><td><div lang=\"ja\">組み合わせリストの所有者と異なる所有者の共有リストを組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</div></td></tr> </tbody> </table> </div>
* @param xZBaseAccountId <div lang=\"ja\">アカウントIDを指定してください。</div> <div lang=\"en\">Specify Account ID.</div> (required)
* @param audienceListServiceOperation (optional)
* @return AudienceListServiceMutateResponse
* @throws RestClientException if an error occurs while attempting to invoke the API
*/
public AudienceListServiceMutateResponse audienceListServiceRemovePost(Long xZBaseAccountId, AudienceListServiceOperation audienceListServiceOperation) throws RestClientException {
return audienceListServiceRemovePostWithHttpInfo(xZBaseAccountId, audienceListServiceOperation).getBody();
}
/**
*
* <div lang=\"ja\">オーディエンスリストを削除します。</div> <div lang=\"en\">Deletes audience list.</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>
*
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>
*
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>V0001</td><td>Invalid value.</td><td><div lang=\"ja\">値が無効です。</div><div lang=\"en\">The value is invalid.</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>F0001</td><td>Invalid format.</td><td><div lang=\"ja\">値の形式が不正です。</div><div lang=\"en\">The value format is invalid.</div></td></tr> <tr><td>110005</td><td>Not a valid id.</td><td><div lang=\"ja\">IDが有効ではありません。</div><div lang=\"en\">Not a valid id.</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>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>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>120020</td><td>Can not set value.</td><td><div lang=\"ja\">値を設定することができません。</div><div lang=\"en\">Value cannot be set.</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>210001</td><td>Selected value is not approved to update.</td><td><div lang=\"ja\">選択した内容は更新が許可されておりません。</div><div lang=\"en\">The selected elements is not approved to use for the updates of target list.</div></td></tr> <tr><td>210002</td><td>Cannot update from the dependency.</td><td><div lang=\"ja\">依存関係があるため、更新できません。</div><div lang=\"en\">Due to the dependency relations</div></td></tr> <tr><td>210003</td><td>A function is not permitted this account.</td><td><div lang=\"ja\">利用が許可されていないアカウントです。</div><div lang=\"en\">Custom audience is not available for this account.</div></td></tr> <tr><td>211005</td><td>Cannot remove shared audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループと紐づく共有リストは削除できません。</div><div lang=\"en\">Cannot remove shared audience list set to AdGroup.</div></td></tr> <tr><td>211006</td><td>Cannot set shared audience list as baseList.</td><td><div lang=\"ja\">共有リストをベースにした類似リストは作成できません。</div><div lang=\"en\">Cannot set shared audience list as baseList.</div></td></tr> <tr><td>211007</td><td>Cannot incorporate a non-shared list into a shared combination list.</td><td><div lang=\"ja\">共有されていないリストを共有されている組み合わせリストに組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a non-shared list into a shared combination list.</div></td></tr> <tr><td>211008</td><td>Cannot remove a audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループに紐づくオーディエンスリストは削除できません。</div><div lang=\"en\">Cannot remove a audience list set to AdGroup.</div></td></tr> <tr><td>211009</td><td>Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</td><td><div lang=\"ja\">組み合わせリストの所有者と異なる所有者の共有リストを組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</div></td></tr> </tbody> </table> </div>
* @param xZBaseAccountId <div lang=\"ja\">アカウントIDを指定してください。</div> <div lang=\"en\">Specify Account ID.</div> (required)
* @param audienceListServiceOperation (optional)
* @return ResponseEntity<AudienceListServiceMutateResponse>
* @throws RestClientException if an error occurs while attempting to invoke the API
*/
public ResponseEntity audienceListServiceRemovePostWithHttpInfo(Long xZBaseAccountId, AudienceListServiceOperation audienceListServiceOperation) throws RestClientException {
Object postBody = audienceListServiceOperation;
// verify the required parameter 'xZBaseAccountId' is set
if (xZBaseAccountId == null) {
throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'xZBaseAccountId' when calling audienceListServiceRemovePost");
}
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("/AudienceListService/remove", HttpMethod.POST, Collections.emptyMap(), queryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, authNames, returnType);
}
/**
*
* <div lang=\"ja\">オーディエンスリストを更新します。</div> <div lang=\"en\">Updates audience list.</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>
*
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>
*
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>V0001</td><td>Invalid value.</td><td><div lang=\"ja\">値が無効です。</div><div lang=\"en\">The value is invalid.</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>F0001</td><td>Invalid format.</td><td><div lang=\"ja\">値の形式が不正です。</div><div lang=\"en\">The value format is invalid.</div></td></tr> <tr><td>110005</td><td>Not a valid id.</td><td><div lang=\"ja\">IDが有効ではありません。</div><div lang=\"en\">Not a valid id.</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>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>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>120020</td><td>Can not set value.</td><td><div lang=\"ja\">値を設定することができません。</div><div lang=\"en\">Value cannot be set.</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>210001</td><td>Selected value is not approved to update.</td><td><div lang=\"ja\">選択した内容は更新が許可されておりません。</div><div lang=\"en\">The selected elements is not approved to use for the updates of target list.</div></td></tr> <tr><td>210002</td><td>Cannot update from the dependency.</td><td><div lang=\"ja\">依存関係があるため、更新できません。</div><div lang=\"en\">Due to the dependency relations</div></td></tr> <tr><td>210003</td><td>A function is not permitted this account.</td><td><div lang=\"ja\">利用が許可されていないアカウントです。</div><div lang=\"en\">Custom audience is not available for this account.</div></td></tr> <tr><td>211005</td><td>Cannot remove shared audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループと紐づく共有リストは削除できません。</div><div lang=\"en\">Cannot remove shared audience list set to AdGroup.</div></td></tr> <tr><td>211006</td><td>Cannot set shared audience list as baseList.</td><td><div lang=\"ja\">共有リストをベースにした類似リストは作成できません。</div><div lang=\"en\">Cannot set shared audience list as baseList.</div></td></tr> <tr><td>211007</td><td>Cannot incorporate a non-shared list into a shared combination list.</td><td><div lang=\"ja\">共有されていないリストを共有されている組み合わせリストに組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a non-shared list into a shared combination list.</div></td></tr> <tr><td>211008</td><td>Cannot remove a audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループに紐づくオーディエンスリストは削除できません。</div><div lang=\"en\">Cannot remove a audience list set to AdGroup.</div></td></tr> <tr><td>211009</td><td>Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</td><td><div lang=\"ja\">組み合わせリストの所有者と異なる所有者の共有リストを組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</div></td></tr> <tr><td>211011</td><td>Contain unavailable ad action user lists.</td><td><div lang=\"ja\">広告データ利用基準に抵触している広告アクションユーザーリストを用いて類似リストまたは組み合わせリストを作成することはできません。</div><div lang=\"en\">Cannot create a similarity list or a combination list using ad action user lists which are in violation of Advertising Data Usage Standards.</div></td></tr> </tbody> </table> </div>
* @param xZBaseAccountId <div lang=\"ja\">アカウントIDを指定してください。</div> <div lang=\"en\">Specify Account ID.</div> (required)
* @param audienceListServiceOperation (optional)
* @return AudienceListServiceMutateResponse
* @throws RestClientException if an error occurs while attempting to invoke the API
*/
public AudienceListServiceMutateResponse audienceListServiceSetPost(Long xZBaseAccountId, AudienceListServiceOperation audienceListServiceOperation) throws RestClientException {
return audienceListServiceSetPostWithHttpInfo(xZBaseAccountId, audienceListServiceOperation).getBody();
}
/**
*
* <div lang=\"ja\">オーディエンスリストを更新します。</div> <div lang=\"en\">Updates audience list.</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>
*
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>
*
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>V0001</td><td>Invalid value.</td><td><div lang=\"ja\">値が無効です。</div><div lang=\"en\">The value is invalid.</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>F0001</td><td>Invalid format.</td><td><div lang=\"ja\">値の形式が不正です。</div><div lang=\"en\">The value format is invalid.</div></td></tr> <tr><td>110005</td><td>Not a valid id.</td><td><div lang=\"ja\">IDが有効ではありません。</div><div lang=\"en\">Not a valid id.</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>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>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>120020</td><td>Can not set value.</td><td><div lang=\"ja\">値を設定することができません。</div><div lang=\"en\">Value cannot be set.</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>210001</td><td>Selected value is not approved to update.</td><td><div lang=\"ja\">選択した内容は更新が許可されておりません。</div><div lang=\"en\">The selected elements is not approved to use for the updates of target list.</div></td></tr> <tr><td>210002</td><td>Cannot update from the dependency.</td><td><div lang=\"ja\">依存関係があるため、更新できません。</div><div lang=\"en\">Due to the dependency relations</div></td></tr> <tr><td>210003</td><td>A function is not permitted this account.</td><td><div lang=\"ja\">利用が許可されていないアカウントです。</div><div lang=\"en\">Custom audience is not available for this account.</div></td></tr> <tr><td>211005</td><td>Cannot remove shared audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループと紐づく共有リストは削除できません。</div><div lang=\"en\">Cannot remove shared audience list set to AdGroup.</div></td></tr> <tr><td>211006</td><td>Cannot set shared audience list as baseList.</td><td><div lang=\"ja\">共有リストをベースにした類似リストは作成できません。</div><div lang=\"en\">Cannot set shared audience list as baseList.</div></td></tr> <tr><td>211007</td><td>Cannot incorporate a non-shared list into a shared combination list.</td><td><div lang=\"ja\">共有されていないリストを共有されている組み合わせリストに組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a non-shared list into a shared combination list.</div></td></tr> <tr><td>211008</td><td>Cannot remove a audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループに紐づくオーディエンスリストは削除できません。</div><div lang=\"en\">Cannot remove a audience list set to AdGroup.</div></td></tr> <tr><td>211009</td><td>Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</td><td><div lang=\"ja\">組み合わせリストの所有者と異なる所有者の共有リストを組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</div></td></tr> <tr><td>211011</td><td>Contain unavailable ad action user lists.</td><td><div lang=\"ja\">広告データ利用基準に抵触している広告アクションユーザーリストを用いて類似リストまたは組み合わせリストを作成することはできません。</div><div lang=\"en\">Cannot create a similarity list or a combination list using ad action user lists which are in violation of Advertising Data Usage Standards.</div></td></tr> </tbody> </table> </div>
* @param xZBaseAccountId <div lang=\"ja\">アカウントIDを指定してください。</div> <div lang=\"en\">Specify Account ID.</div> (required)
* @param audienceListServiceOperation (optional)
* @return ResponseEntity<AudienceListServiceMutateResponse>
* @throws RestClientException if an error occurs while attempting to invoke the API
*/
public ResponseEntity audienceListServiceSetPostWithHttpInfo(Long xZBaseAccountId, AudienceListServiceOperation audienceListServiceOperation) throws RestClientException {
Object postBody = audienceListServiceOperation;
// verify the required parameter 'xZBaseAccountId' is set
if (xZBaseAccountId == null) {
throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'xZBaseAccountId' when calling audienceListServiceSetPost");
}
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("/AudienceListService/set", HttpMethod.POST, Collections.emptyMap(), queryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, authNames, returnType);
}
/**
*
* <div lang=\"ja\"> オーディエンスリスト(顧客データ)のユーザリストファイルをアップロードします。<br/> アップロードリクエストでは以下を指定します。<br/> テストアカウントでは利用頂けない機能です。 <ul> <li>・Content-Type: multipart/form-data</li> </ul> また、アップロードするファイルの制限は下記の通りです。 <ul> <li>・UTF8(BOMなし)、Shift-JIS正規化形式</li> <li>・ユーザーIDごとに改行</li> <li>・改行コードLF、CRLF</li> <li>・ファイルサイズ上限1GB(1,073,741,824 byte)</li> </ul> </div> <div lang=\"en\"> Upload the user list file for audience list (customer data). <br/> Specify the following in the upload request.<br/> The action is unavailable for test account. <ul> <li>* Content-Type: application/octet-stream (text/plain can also be specified for uncompressed format)</li> </ul> The following is the file upload limit. <ul> <li>* UTF8(without BOM), Shift-JIS canonicalized form.</li> <li>* Line break for each user ID</li> <li>* Line feed code LF, CRLF</li> <li>* File size upper limit 1GB(1,073,741,824 byte)</li> </ul> </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>
*
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>
*
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>V0001</td><td>Invalid value.</td><td><div lang=\"ja\">値が無効です。</div><div lang=\"en\">The value is invalid.</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>F0001</td><td>Invalid format.</td><td><div lang=\"ja\">値の形式が不正です。</div><div lang=\"en\">The value format is invalid.</div></td></tr> <tr><td>110005</td><td>Not a valid id.</td><td><div lang=\"ja\">IDが有効ではありません。</div><div lang=\"en\">Not a valid id.</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>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>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>120020</td><td>Can not set value.</td><td><div lang=\"ja\">値を設定することができません。</div><div lang=\"en\">Value cannot be set.</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>210001</td><td>Selected value is not approved to update.</td><td><div lang=\"ja\">選択した内容は更新が許可されておりません。</div><div lang=\"en\">The selected elements is not approved to use for the updates of target list.</div></td></tr> <tr><td>210002</td><td>Cannot update from the dependency.</td><td><div lang=\"ja\">依存関係があるため、更新できません。</div><div lang=\"en\">Due to the dependency relations</div></td></tr> <tr><td>210003</td><td>A function is not permitted this account.</td><td><div lang=\"ja\">利用が許可されていないアカウントです。</div><div lang=\"en\">Custom audience is not available for this account.</div></td></tr> <tr><td>211005</td><td>Cannot remove shared audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループと紐づく共有リストは削除できません。</div><div lang=\"en\">Cannot remove shared audience list set to AdGroup.</div></td></tr> <tr><td>211006</td><td>Cannot set shared audience list as baseList.</td><td><div lang=\"ja\">共有リストをベースにした類似リストは作成できません。</div><div lang=\"en\">Cannot set shared audience list as baseList.</div></td></tr> <tr><td>211007</td><td>Cannot incorporate a non-shared list into a shared combination list.</td><td><div lang=\"ja\">共有されていないリストを共有されている組み合わせリストに組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a non-shared list into a shared combination list.</div></td></tr> <tr><td>211008</td><td>Cannot remove a audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループに紐づくオーディエンスリストは削除できません。</div><div lang=\"en\">Cannot remove a audience list set to AdGroup.</div></td></tr> <tr><td>211009</td><td>Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</td><td><div lang=\"ja\">組み合わせリストの所有者と異なる所有者の共有リストを組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</div></td></tr> <tr><td>0200</td><td>The action is unavailable for test account.</td><td><div lang=\"ja\">テストアカウントでは利用頂けない機能です。</div><div lang=\"en\">The action is unavailable for test account.</div></td></tr> </tbody> </table> </div>
* @param xZBaseAccountId <div lang=\"ja\">アカウントIDを指定してください。</div> <div lang=\"en\">Specify Account ID.</div> (required)
* @param accountId <div lang=\"ja\">アカウントIDです。</div> <div lang=\"en\">Account ID.</div> (required)
* @param audienceListId <div lang=\"ja\">オーディエンスリストIDです。</div> <div lang=\"en\">Audience list ID.</div> (required)
* @param uploadType <div lang=\"ja\"> AudienceListServiceUploadUserListUploadTypeは、アップロードする方法の種類を表します。<br> ハッシュ化メールアドレスまたは電話番号の詳細については、<a href=\"https://ads-help.yahoo-net.jp/s/article/H000044507?language=ja\">ヘルプ</a>をご参照ください。 </div> <div lang=\"en\"> AudienceListServiceUploadUserListUploadType displays kind of upload method.<br> Refer to <a href=\"https://ads-help.yahoo-net.jp/s/article/H000044507?language=en_US\">Help page</a> for more details about hashed Email Address and Phone Number. </div> </div> <dl class=term> <dt class=\"term__item\"><code>IDFA</dt> <dd class=\"term__desc\"><span lang=\"ja\">iOS端末用広告識別子です。</span><span lang=\"en\">Ad identifier for iOS devices.</span></dd> <dt class=\"term__item\"><code>AAID</dt> <dd class=\"term__desc\"><span lang=\"ja\">Android端末用広告識別子です。</span><span lang=\"en\">Ad identifier for Android devices.</span></dd> <dt class=\"term__item\"><code>MAIL_ADDRESS_AND_PHONE_NUMBER</dt> <dd class=\"term__desc\"><span lang=\"ja\">ハッシュ化メールアドレスまたは電話番号です。</span><span lang=\"en\">Hashed email address or phone number.</span></dd> <dt class=\"term__item\"><code>UNKNOWN</dt> <dd class=\"term__desc\"><span lang=\"ja\">未知の値です。</span><span lang=\"en\">Unknown Value</span></dd> </dl> (required)
* @param compressType <div lang=\"ja\">AudienceListServiceUploadUserListCompressTypeは、アップロードするファイルの圧縮形式を表します。</div> <div lang=\"en\">AudienceListServiceUploadUserListCompressType displays kind of compress type of upload file.</div> <dl class=term> <dt class=\"term__item\"><code>NONE</dt> <dd class=\"term__desc\"><span lang=\"ja\">非圧縮形式です。</span><span lang=\"en\">Uncompressed format.</span></dd> <dt class=\"term__item\"><code>ZIP</dt> <dd class=\"term__desc\"><span lang=\"ja\">ZIP形式です。</span><span lang=\"en\">ZIP format. </span></dd> <dt class=\"term__item\"><code>GZIP</dt> <dd class=\"term__desc\"><span lang=\"ja\">GZIP形式です。</span><span lang=\"en\">GZIP format.</span></dd> <dt class=\"term__item\"><code>UNKNOWN</dt> <dd class=\"term__desc\"><span lang=\"ja\">未知の値です。</span><span lang=\"en\">Unknown Value</span></dd> </dl> (required)
* @param _file (required)
* @return AudienceListServiceUploadUserListResponse
* @throws RestClientException if an error occurs while attempting to invoke the API
*/
public AudienceListServiceUploadUserListResponse audienceListServiceUploadUserListPost(Long xZBaseAccountId, Long accountId, Long audienceListId, AudienceListServiceUploadUserListUploadType uploadType, AudienceListServiceUploadUserListCompressType compressType, org.springframework.core.io.Resource _file) throws RestClientException {
return audienceListServiceUploadUserListPostWithHttpInfo(xZBaseAccountId, accountId, audienceListId, uploadType, compressType, _file).getBody();
}
/**
*
* <div lang=\"ja\"> オーディエンスリスト(顧客データ)のユーザリストファイルをアップロードします。<br/> アップロードリクエストでは以下を指定します。<br/> テストアカウントでは利用頂けない機能です。 <ul> <li>・Content-Type: multipart/form-data</li> </ul> また、アップロードするファイルの制限は下記の通りです。 <ul> <li>・UTF8(BOMなし)、Shift-JIS正規化形式</li> <li>・ユーザーIDごとに改行</li> <li>・改行コードLF、CRLF</li> <li>・ファイルサイズ上限1GB(1,073,741,824 byte)</li> </ul> </div> <div lang=\"en\"> Upload the user list file for audience list (customer data). <br/> Specify the following in the upload request.<br/> The action is unavailable for test account. <ul> <li>* Content-Type: application/octet-stream (text/plain can also be specified for uncompressed format)</li> </ul> The following is the file upload limit. <ul> <li>* UTF8(without BOM), Shift-JIS canonicalized form.</li> <li>* Line break for each user ID</li> <li>* Line feed code LF, CRLF</li> <li>* File size upper limit 1GB(1,073,741,824 byte)</li> </ul> </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>
*
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>
*
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>V0001</td><td>Invalid value.</td><td><div lang=\"ja\">値が無効です。</div><div lang=\"en\">The value is invalid.</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>F0001</td><td>Invalid format.</td><td><div lang=\"ja\">値の形式が不正です。</div><div lang=\"en\">The value format is invalid.</div></td></tr> <tr><td>110005</td><td>Not a valid id.</td><td><div lang=\"ja\">IDが有効ではありません。</div><div lang=\"en\">Not a valid id.</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>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>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>120020</td><td>Can not set value.</td><td><div lang=\"ja\">値を設定することができません。</div><div lang=\"en\">Value cannot be set.</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>210001</td><td>Selected value is not approved to update.</td><td><div lang=\"ja\">選択した内容は更新が許可されておりません。</div><div lang=\"en\">The selected elements is not approved to use for the updates of target list.</div></td></tr> <tr><td>210002</td><td>Cannot update from the dependency.</td><td><div lang=\"ja\">依存関係があるため、更新できません。</div><div lang=\"en\">Due to the dependency relations</div></td></tr> <tr><td>210003</td><td>A function is not permitted this account.</td><td><div lang=\"ja\">利用が許可されていないアカウントです。</div><div lang=\"en\">Custom audience is not available for this account.</div></td></tr> <tr><td>211005</td><td>Cannot remove shared audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループと紐づく共有リストは削除できません。</div><div lang=\"en\">Cannot remove shared audience list set to AdGroup.</div></td></tr> <tr><td>211006</td><td>Cannot set shared audience list as baseList.</td><td><div lang=\"ja\">共有リストをベースにした類似リストは作成できません。</div><div lang=\"en\">Cannot set shared audience list as baseList.</div></td></tr> <tr><td>211007</td><td>Cannot incorporate a non-shared list into a shared combination list.</td><td><div lang=\"ja\">共有されていないリストを共有されている組み合わせリストに組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a non-shared list into a shared combination list.</div></td></tr> <tr><td>211008</td><td>Cannot remove a audience list set to AdGroup.</td><td><div lang=\"ja\">広告グループに紐づくオーディエンスリストは削除できません。</div><div lang=\"en\">Cannot remove a audience list set to AdGroup.</div></td></tr> <tr><td>211009</td><td>Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</td><td><div lang=\"ja\">組み合わせリストの所有者と異なる所有者の共有リストを組み込むことはできません。</div><div lang=\"en\">Cannot incorporate a shared list that belongs to an owner who's different from the owner of a combination list.</div></td></tr> <tr><td>0200</td><td>The action is unavailable for test account.</td><td><div lang=\"ja\">テストアカウントでは利用頂けない機能です。</div><div lang=\"en\">The action is unavailable for test account.</div></td></tr> </tbody> </table> </div>
* @param xZBaseAccountId <div lang=\"ja\">アカウントIDを指定してください。</div> <div lang=\"en\">Specify Account ID.</div> (required)
* @param accountId <div lang=\"ja\">アカウントIDです。</div> <div lang=\"en\">Account ID.</div> (required)
* @param audienceListId <div lang=\"ja\">オーディエンスリストIDです。</div> <div lang=\"en\">Audience list ID.</div> (required)
* @param uploadType <div lang=\"ja\"> AudienceListServiceUploadUserListUploadTypeは、アップロードする方法の種類を表します。<br> ハッシュ化メールアドレスまたは電話番号の詳細については、<a href=\"https://ads-help.yahoo-net.jp/s/article/H000044507?language=ja\">ヘルプ</a>をご参照ください。 </div> <div lang=\"en\"> AudienceListServiceUploadUserListUploadType displays kind of upload method.<br> Refer to <a href=\"https://ads-help.yahoo-net.jp/s/article/H000044507?language=en_US\">Help page</a> for more details about hashed Email Address and Phone Number. </div> </div> <dl class=term> <dt class=\"term__item\"><code>IDFA</dt> <dd class=\"term__desc\"><span lang=\"ja\">iOS端末用広告識別子です。</span><span lang=\"en\">Ad identifier for iOS devices.</span></dd> <dt class=\"term__item\"><code>AAID</dt> <dd class=\"term__desc\"><span lang=\"ja\">Android端末用広告識別子です。</span><span lang=\"en\">Ad identifier for Android devices.</span></dd> <dt class=\"term__item\"><code>MAIL_ADDRESS_AND_PHONE_NUMBER</dt> <dd class=\"term__desc\"><span lang=\"ja\">ハッシュ化メールアドレスまたは電話番号です。</span><span lang=\"en\">Hashed email address or phone number.</span></dd> <dt class=\"term__item\"><code>UNKNOWN</dt> <dd class=\"term__desc\"><span lang=\"ja\">未知の値です。</span><span lang=\"en\">Unknown Value</span></dd> </dl> (required)
* @param compressType <div lang=\"ja\">AudienceListServiceUploadUserListCompressTypeは、アップロードするファイルの圧縮形式を表します。</div> <div lang=\"en\">AudienceListServiceUploadUserListCompressType displays kind of compress type of upload file.</div> <dl class=term> <dt class=\"term__item\"><code>NONE</dt> <dd class=\"term__desc\"><span lang=\"ja\">非圧縮形式です。</span><span lang=\"en\">Uncompressed format.</span></dd> <dt class=\"term__item\"><code>ZIP</dt> <dd class=\"term__desc\"><span lang=\"ja\">ZIP形式です。</span><span lang=\"en\">ZIP format. </span></dd> <dt class=\"term__item\"><code>GZIP</dt> <dd class=\"term__desc\"><span lang=\"ja\">GZIP形式です。</span><span lang=\"en\">GZIP format.</span></dd> <dt class=\"term__item\"><code>UNKNOWN</dt> <dd class=\"term__desc\"><span lang=\"ja\">未知の値です。</span><span lang=\"en\">Unknown Value</span></dd> </dl> (required)
* @param _file (required)
* @return ResponseEntity<AudienceListServiceUploadUserListResponse>
* @throws RestClientException if an error occurs while attempting to invoke the API
*/
public ResponseEntity audienceListServiceUploadUserListPostWithHttpInfo(Long xZBaseAccountId, Long accountId, Long audienceListId, AudienceListServiceUploadUserListUploadType uploadType, AudienceListServiceUploadUserListCompressType compressType, org.springframework.core.io.Resource _file) throws RestClientException {
Object postBody = null;
// verify the required parameter 'xZBaseAccountId' is set
if (xZBaseAccountId == null) {
throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'xZBaseAccountId' when calling audienceListServiceUploadUserListPost");
}
// verify the required parameter 'accountId' is set
if (accountId == null) {
throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'accountId' when calling audienceListServiceUploadUserListPost");
}
// verify the required parameter 'audienceListId' is set
if (audienceListId == null) {
throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'audienceListId' when calling audienceListServiceUploadUserListPost");
}
// verify the required parameter 'uploadType' is set
if (uploadType == null) {
throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'uploadType' when calling audienceListServiceUploadUserListPost");
}
// verify the required parameter 'compressType' is set
if (compressType == null) {
throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter 'compressType' when calling audienceListServiceUploadUserListPost");
}
// verify the required parameter '_file' is set
if (_file == null) {
throw new HttpClientErrorException(HttpStatus.BAD_REQUEST, "Missing the required parameter '_file' when calling audienceListServiceUploadUserListPost");
}
final MultiValueMap queryParams = new LinkedMultiValueMap();
final HttpHeaders headerParams = new HttpHeaders();
final MultiValueMap cookieParams = new LinkedMultiValueMap();
final MultiValueMap formParams = new LinkedMultiValueMap();
queryParams.putAll(apiClient.parameterToMultiValueMap(null, "accountId", accountId));
queryParams.putAll(apiClient.parameterToMultiValueMap(null, "audienceListId", audienceListId));
queryParams.putAll(apiClient.parameterToMultiValueMap(null, "uploadType", uploadType));
queryParams.putAll(apiClient.parameterToMultiValueMap(null, "compressType", compressType));
if (xZBaseAccountId != null)
headerParams.add("x-z-base-account-id", apiClient.parameterToString(xZBaseAccountId));
if (_file != null)
formParams.add("file", _file);
final String[] localVarAccepts = {
"application/json"
};
final List localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);
final String[] contentTypes = {
"multipart/form-data"
};
final MediaType localVarContentType = apiClient.selectHeaderContentType(contentTypes);
String[] authNames = new String[] { "oAuth" };
ParameterizedTypeReference returnType = new ParameterizedTypeReference() {};
return apiClient.invokeAPI("/AudienceListService/uploadUserList", HttpMethod.POST, Collections.emptyMap(), queryParams, postBody, headerParams, cookieParams, formParams, localVarAccept, localVarContentType, authNames, returnType);
}
}