リクエストが成功した場合、ディスプレイ広告APIは、Status: 200 OK、というHTTPステータスコードと、ディスプレイ広告APIのレスポンスを返します。
リクエストの処理中にエラーが発生した場合、ディスプレイ広告APIは、エラーコードが含まれるメッセージを返します。
エラーレスポンスには、HTTPステータス、全体エラー、部分エラーがあります。
以下で各レスポンスについて説明します。
リクエスト構文違反、システムエラー、認証エラーなどは、Status: 200 OK、以外のHTTPステータスコードが返却されます。
例えば、AccountService:getでアカウントの情報を取得する際、アクセストークンの認証に失敗した場合、Status: 401 UnauthorizedのHTTPステータスコードと、以下のエラーコードが含まれるメッセージを返します。
{
"accountIds": [
11111111
],
"numberResults": 0,
"startIndex": 1
}
{
"rid": "178ed42a0e8f26acbb37ac2da2969bdd",
"errors": [
{
"code": "0111",
"message": "Authentication failed.",
"details": []
}
]
}
※その他のHTTPステータスは、APIリファレンスを参照してください。
リクエストの制約などにより、リクエスト全体が失敗した場合は、Status: 200 OKのレスポンスコードが返されますが、全体エラーのレスポンスが返却されます。
以下は、AccountService:get、で、numberResults の値（ページ数）が不正な場合のエラーレスポンス例です。
{
"accountIds": [
11111111
],
"numberResults": 0,
"startIndex": 1
}
{
"rid": "02505e66279a0a103f05421a6529ac7b",
"errors": [
{
"code": "0001",
"message": "Invalid Request.",
"details": [
{
"requestKey": "numberResults",
"requestValue": "must be greater than or equal to 1"
}
]
}
]
}
operand 内の各要素の制約などによりエラーが発生した場合は、Status: 200 OKのレスポンスコードが返されますが、部分エラーのレスポンスが返却されます。
部分エラーは、各 operand ごとにエラーが発生したかについて返却します。
なお、一回のリクエストで複数の operand を送るなど、複数の操作を要求するリクエストを送った場合、operationSucceeded の値が true とfalse が混在するエラーレスポンスになる場合もあります。
以下は、ReportDefinitionService:add、で問題ないoperand（Sample Report Definition）と、dateRange（レポート取得期間）に問題ある値を指定したoperand（Sample Report Definition2）を、同時にリクエストしたときのレスポンス例です。
{
"accountId": 11111111,
"operand": [
{
"dateRangeType": "TODAY",
"fields": [
"COST",
"IMPS"
],
"lang": "JA",
"reportName": "ex_report_01"
},
{
"dateRange": {
"endDate": "20190901",
"startDate": "20190930"
},
"dateRangeType": "CUSTOM_DATE",
"fields": [
"COST",
"IMPS"
],
"lang": "JA",
"reportName": "ex_report_02"
}
]
}
{
"errors": null,
"rid": "b3402cb66f05977f9deebfb39eaaf345",
"rval": {
"values": [
{
"errors": null,
"operationSucceeded": true,
"reportDefinition": {
"accountId": 11111111,
"completeTime": null,
"dateRange": null,
"dateRangeType": "TODAY",
"downloadEncode": "UTF-8",
"downloadFormat": "CSV",
"fields": [
"COST",
"IMPS"
],
"filters": null,
"frequencyRange": null,
"jobStatus": "ACCEPTED",
"lang": "JA",
"reportJobErrorDetail": null,
"reportJobId": 22222222,
"reportName": "ex_report_01",
"requestTime": "20200721135246",
"sortFields": null,
"zip": "OFF"
}
},
{
"errors": [
{
"code": "V0001",
"message": "Invalid value.",
"details": [
{
"requestKey": "dateRange.startDate",
"requestValue": "20190930"
},
{
"requestKey": "dateRange.endDate",
"requestValue": "20190901"
}
]
}
],
"operationSucceeded": false,
"reportDefinition": null
}
]
}
}
| コード | メッセージ | 説明 |
|---|---|---|
| F0001 | Invalid format. | 値の形式が不正です。 |
| R0001 | Require. | 必須です。 |
| V0001 | Invalid value. | 値が無効です。 |
| L0001 | Lower list size. | 配列の要素数が下限値を下回っています。 |
| L0002 | Over list size. | 配列の要素数が上限値を超過しています。 |
| U0002 | Invalid url. | アップロードURLまたはダウンロードURLが不正です。 |
| S0001 | Invalid Status. | ステータスが無効です。 |
| I0001 | Deactivated Id. | IDが無効です。 |
| D0001 | Duplicate. | 一意な値が重複しています。 |
| RL001 | Invalid relation. | リクエストの関連性が矛盾しています。 たとえば、開始＞終了の日付指定を行なっているなど |
| LT001 | Over limit. | 登録できる上限値を超過しています。 |
| 0001 | Invalid Request. | さまざまな要因が考えられます。 主な要因は、パラメータの値が不正か、誤りがあるためにオペレーションが完了できません。 |
| 0002 | An internal error has occurred. | 内部エラーが発生しました。再度操作を実行してください。 もし、問題が解決しない場合は、お問い合わせページをご利用ください。 |
| 0003 | Frequency limit exceeded. Please try your request again later | アクセス頻度が上限値に達しました。時間をおいて再度実行してください。 |
| 0004 | URL not found. | URLが不正です。 |
| 0005 | Bad request. | リクエストが不正です。 |
| 0098 | Permission denied. | 権限がありません。 |
| 0099 | Out of service. | APIがメンテナンス中、またはご利用できません。 |
※各Service固有のエラーは、APIリファレンスを参照してください。