Response
Page
The table below shows information about the pagination parameters in a response.
The maximum value in size is 100.
| Value | Type | Description |
|---|---|---|
| contents | Object[] | Content list |
| page | Integer | Page number |
| size | Integer | Number of items in each page |
| totalElements | Long | Total number of items |
| totalPages | Integer | Total number of pages |
| sort | Object | Sorting order |
| first | boolean | Indicates whether the requested page is the first page of results. |
| last | boolean | Indicates whether the requested page is the last page of results. |
Response codes
HTTP status codes
| Code | Message | Description |
|---|---|---|
| 200 | OK | The request was successful. |
| 400 | Bad Request | The request was wrong or inaccurate. |
| 401 | Unauthorized | Failed to authenticate the request. |
| 403 | Forbidden | The server cannot process the request due to lack of permission or authorization. |
| 422 | Unprocessable Entity | The syntax of the request entity is correct, but it was unable to process the contained instructions. |
| 429 | Too Many Requests | The user has sent too many requests in a given amount of time. |
| 500 | Internal Server Error | Server error. If this error persists, you need to report it. |
Troubleshoot error codes
- 400 Bad Request
- You need to fix wrong parameters in a request and then call it again.
{
"error": {
"code": "BAD_REQUEST",
"message": "Bad Request",
"description": "An ad group ([123]) which does not belong to an ad account (1017) exists."
}
}
- 422 Unprocessable Entity
- detailCode: There is a corresponding code value for each case. See the description for the detail code.
{
"error": {
"code": "CONDITION_DOES_NOT_MEET",
"detailCode": "AD__BID_PRICE_OUT_OF_RANGE",
"message": "The bidPrice field value is outside of the valid range.",
"description": "Allowed minimum amount: 10, Maximum amount: 1000000, Input value (adSetNo: 99145, bidPrice: 10000000000000)"
}
}
Code
This section describes what each
codemeans.It consists of codes associated with some of the HTTP status codes above.
| HTTP status code | Code |
|---|---|
| 400 | BAD_REQUEST |
| 401 | AUTH_ERROR |
| 422 | CONDITION_DOES_NOT_MEET DATA_NOT_EXIST INVALID_PARAMETER |
| 500 | UNKNOWN_ERROR |
Detail code
This section describes what each
detailCodemeans.You can find how to troubleshoot each error.
| Code | Description |
|---|---|
| AD__BID_STRATEGY_VALUE_OUT_OF_RANGE | The bid limit is outside the allowed range. |
| AD__BID_PRICE_OUT_OF_RANGE | The bid amount is outside the allowed range. |
| AD__AD_SET_BUDGET_OUT_OF_RANGE | The 'ad group budget' is outside the allowed range. |
| AD__AD_SET_CANNOT_CREATE_EXCEED_MAX | Cannot create a new ad group because the maximum number of ad groups has been reached. |
| AD__AD_SET_CANNOT_SELECT | The ad group cannot be selected. |
| AD__AD_SET_GENDER_MUST_BE_SELECTED_AT_LEAST_ONE | At least one gender must be selected. (Excluding unknown) |
| AD__AD_SET_NOT_EXIST | The ad group information does not exist. |
| AD__AD_SET_CAMPAIGN_NOT_EXIST | The campaign linked to the ad group does not exist. |
| AD__AD_SET_CANNOT_CREATE | Cannot create the ad group. |
| AD__AD_SET_TARGETING_TYPE_NOT_NULL | The targeting type must not be empty. |
| AD__AD_SET_INVALID_NAME_FORMAT | The ad group name must be between 2 and 128 characters. |
| AD__AD_SET_CONTEXT_TARGETING_TYPE_NOT_AVAILABLE_CAMPAIGN_OBJECTIVE | The [Context] targeting type cannot be used in ad groups under the current campaign objective {objective}. |
| AD__AD_SET_INVALID_TARGETING_TYPE | The targeting type is invalid. |
| AD__AD_SET_BROAD_TARGET_CAN_USE_AT_CATALOG | Expanded targeting can be set only for catalog campaign ads. |
| AD__AD_SET_INCLUDE_FEED_AUTO_TARGETING_NOT_SUPPORTED_SHOPPING_CAMPAIGN | Feed ad automatic targeting expansion cannot be set in shopping campaigns. |
| AD__AD_SET_NOT_ALLOWED | You do not have permission to access the ad group. |
| AD__AD_SET_NOT_EXIST_AT_AD_SET_NO | The ad group information {adSetNo} does not exist. |
| AD__AD_SET_CUSTOM_TARGET_NOT_ALLOWED | You do not have permission to retrieve audience information. |
| AD__AD_SET_CUSTOM_TARGET_CANNOT_INCLUDE_SEED_COUNT | This population can be used for target exclusion only. |
| AD__AD_SET_CUSTOM_TARGET_CANNOT_USE | The audience information cannot be used or has been deleted. |
| AD__AD_SET_CUSTOM_TARGET_EXCEED_MAX | The maximum number of audiences allowed per ad group has been exceeded. |
| AD__AD_SET_CUSTOM_TARGET_NOT_EXIST | The audience information does not exist. |
| AD__AD_SET_CUSTOM_TARGET_DISABLED | The audience is unavailable. |
| AD__AD_SET_CUSTOM_TARGET_COUNT_EXCEEDED | Up to n targets can be registered. To register a new target, delete an unused target. |
| AD__AD_SET_CUSTOM_TARGET_NOT_AVAILABLE | The audience is not in an available state. |
| AD__AD_SET_CUSTOM_TARGET_FILE_COUNT_EXCEEDED | Up to n 'customer files' can be registered. To register a new 'customer file', delete an unused 'customer file'. |
| AD__AD_SET_CUSTOM_TARGET_CONNECTED_CANNOT_BE_REMOVED | Cannot delete the target. It cannot be deleted because it is in use by an ad group. To delete the target, first remove it from the audience settings of the ad groups shown in the target usage status. |
| AD__AD_SET_CUSTOM_TARGET_CONNECTED_LOOKALIKE_CANNOT_BE_REMOVED | Cannot delete the target. It cannot be deleted because it is in use by a lookalike target. To delete the target, first remove the lookalike targets created from it. |
| AD__AD_SET_CUSTOM_TARGET_NEED_MORE_COUNT | The include (targeting) setting requires a target population of at least n. |
| AD__AD_SET_CANNOT_SET_SOME_TARGETINGS | You have set targeting that is not allowed for the selected media. |
| AD__AD_SET_CUSTOM_TARGET_MAT_TARGETS_WITH_SAME_CONDITIONS_EXIST | A MAT target created with the same conditions (linked partner, collected event, collection period) is already registered. |
| AD__AD_SET_CUSTOM_TARGET_MAT_CODE_UNREMOVABLE | This conversion key is already linked and cannot be deleted. |
| AD__AD_SET_CUSTOM_TARGET_MAT_CODE_COUNT_EXCEEDED | The maximum number of conversion keys has been exceeded. |
| AD__AD_SET_CUSTOM_TARGET_LOOKALIKE_COUNT_EXCEEDED | Up to n 'lookalike targets' can be registered. To register a new 'lookalike target', delete an unused 'lookalike target'. |
| AD__AD_SET_CUSTOM_TARGET_LOOKALIKE_SAME_CONDITIONS_EXIST | A lookalike target with the same target size for the same SEED target cannot be newly created. Please check again and register. |
| AD__AD_SET_CUSTOM_TARGET_INVALID_CAMPAIGN_OBJECTIVE | NAVER Shopping targets cannot be set in ad groups under the current campaign objective. Please check the audience settings of the ad group again. |
| AD__AD_SET_CUSTOM_TARGET_INVALID_CAMPAIGN_URL | Some NAVER Shopping targets cannot be set because of the representative URL set in the campaign. Please check the audience settings of the ad group again. |
| AD__AD_SET_CUSTOM_TARGET_CANNOT_USE_AT_CONTEXT | The [Context] targeting type does not support audience target settings. |
| AD__AD_SET_CANNOT_TARGET_AIPL_BY_CAMPAIGN_OBJECTIVE | Customer journey targets cannot be set for engagement/app conversion campaigns. |
| AD__AD_SET_CANNOT_TARGET_AIPL_BY_BIZ_CHANNEL | Customer journey targets are provided only when the shopping mall type is 'Smart Store/Brand Store', or when the shopping mall type is 'CPC/CPS' and you have the brandAnalytics permission. |
| AD__AD_SET_DEMOGRAPHIC_AGE_RANGE_INVALID | The age range is invalid. The valid ranges are: {age range} |
| AD__AD_SET_DEMOGRAPHIC_AGE_RANGE_UNKNOWN_MUST_BE_WITH_OTHER | At least one age range must be selected. (Excluding unknown) |
| AD__AD_SET_DEMOGRAPHIC_ADULT_ONLY_CANNOT_EDIT | Adult targeting cannot be turned off once set. |
| AD__AD_SET_DEMOGRAPHIC_TARGET_CANNOT_USE_AT_CONTEXT | The [Context] targeting type does not support demographic target settings. |
| AD__AD_SET_EXTENDED_DEMOGRAPHIC_TARGET_CANNOT_USE_AT_CONTEXT | The [Context] targeting type does not support extended demographic target settings. |
| AD__AD_SET_ADULT_ONLY_TARGET_CANNOT_USE_AT_CONTEXT | The [Context] targeting type does not support adult targeting settings. |
| AD__AD_SET_EXTENDED_DEMO_CODE_INVALID | The extended demographic target code ({code}) is invalid. |
| AD__AD_SET_INTEREST_INTERSECTION_INVALID | The target matching method can be set only when both interest targeting and purchase intent targeting are defined. |
| AD__AD_SET_INTEREST_DEPTH_INVALID | The depth of an interest target can only be 1, 2, 3, or 4. |
| AD__AD_SET_INTEREST_TARGET_CANNOT_USE_AT_CONTEXT | The [Context] targeting type does not support interest target settings. |
| AD__AD_SET_PURCHASE_INTENT_TARGET_CANNOT_USE_AT_CONTEXT | The [Context] targeting type does not support purchase intent target settings. |
| AD__AD_SET_INTEREST_FIRST_CODE_INVALID | The first-depth interest target code ({code}) is invalid. |
| AD__AD_SET_INTEREST_SECOND_CODE_INVALID | The second-depth interest target code ({code}) is invalid. |
| AD__AD_SET_INTEREST_THIRD_CODE_INVALID | The third-depth interest target code ({code}) is invalid. |
| AD__AD_SET_INTEREST_FOURTH_CODE_INVALID | The fourth-depth interest target code ({code}) is invalid. |
| AD__AD_SET_INTEREST_CODE_NOT_SET | The interest target code is not set. |
| AD__AD_SET_PURCHASE_INTENT_CODE_INVALID | The purchase intent target code ({code}) is invalid. |
| AD__AD_SET_DEVICE_DEVICE_TYPE_NOT_EMPTY | DeviceType must not be empty. |
| AD__AD_SET_DEVICE_MOBILE_NEED | When the platform is set to [ANDROID/IOS], the 'MOBILE' device type must be set. |
| AD__AD_SET_DEVICE_PLATFORMS_NOT_EMPTY | When the 'MOBILE' device type is set, the platform [ANDROID/IOS] must not be empty. |
| AD__AD_SET_DEVICE_INVALID_PLATFORMS | The platform cannot be set. |
| AD__AD_SET_DEVICE_INVALID_PLATFORMS_ALL_DEVICE | When all devices are selected, all platforms must be entered. |
| AD__AD_SET_DEVICE_INVALID_DEVICES_ALL_DEVICE | When all devices are selected, all selectable devices must be entered. |
| AD__AD_SET_DEVICE_INVALID_DEVICE_TYPES | The device cannot be set. |
| AD__AD_SET_NOT_ALLOWED_ALL_PLACEMENT | Cannot select all placements available for impressions. For the device list [{deviceCodes}] you entered, only the placement list [{placementGroupCodes}] can be selected. |
| AD__AD_SET_PLACEMENT_GROUP_NOT_EMPTY | The placement must not be empty. |
| AD__AD_SET_PLACEMENT_GROUP_INVALID | The placement code ({placementGroupCode}) is invalid. |
| AD__AD_SET_PLACEMENT_GROUP_NOT_COMPATIBLE_WITH_CAMPAIGN_OBJECTIVE_AND_DEVICE_TYPE | The placement code ({placementGroupCode}) is not compatible with the campaign objective ({objective}) and device ({deviceCode}). |
| AD__AD_SET_PLACEMENT_GROUP_NOT_AVAILABLE_WITH_EXTERNAL_SHOPPING_MALL | The placement code (NAVER Shopping area) is not compatible with the business channel of an external shopping mall. |
| AD__AD_SET_PLACEMENT_GROUP_NOT_COMPATIBLE_WITH_TARGETING_TYPE | The placement code ({placementGroupCode}) is not compatible with the targeting type ({targetingType}). |
| AD__AD_SET_LOCATION_UNKNOWN_LOCATION_INVALID | The include-unknown option is available only when a location target is set. |
| AD__AD_SET_LOCATION_TARGET_CANNOT_USE_AT_CONTEXT | The [Context] targeting type does not support location target settings. |
| AD__AD_SET_MUST_INCLUDE_LOCATION_AT_NEARBY | The location of interest must be included when expanding to nearby areas. |
| AD__AD_SET_LOCATION_TARGET_EXCEED_MAX | Up to 1000 location targets can be set. |
| AD__AD_SET_LOCATION_TARGET_INVALID_RCODE | The location code ({locationCode}) is invalid. |
| AD__AD_SET_CONTEXTUAL_TARGETING_CAN_ONLY_CONTEXT_TARGETING | Topic targets are provided only for the [Context] targeting type. |
| AD__AD_SET_INVALID_CONTEXTUAL_TARGETING_CODE | The topic target code ({contextualTargetingCode}) is invalid. |
| AD__AD_SET_INVALID_TIME_FORMAT_DAY_OF_WEEK | The dayOfWeek field must be a value between 1 and 7. |
| AD__AD_SET_INVALID_TIME_FORMAT_HOUR | The start time and end time fields must be a value between 0 and 23. |
| AD__AD_SET_TIME_SLOT_MUST_BE_SET_AT_ADULT_ONLY_AND_SOME_PLACEMENT_GROUP | A detailed schedule must be set when adult targeting is used and the Smart Channel, Integrated Services, or Feed area placement is selected. |
| AD__AD_SET_TIME_SLOT_NOT_ALLOWED_ADULT_ONLY | This detailed schedule cannot be selected when adult targeting is set. |
| AD__AD_SET_END_TIME_SHOULD_NOT_BE_NULL_WHEN_BUDGET_TYPE_IS_TOTAL | The end time must not be empty when the budget type is [total budget]. |
| AD__AD_SET_ACCELERATED_OPTION_NOT_COMPATIBLE_WITH_AUTO_BID | The 'accelerated delivery' option cannot be set when automatic bidding is set. |
| AD__AD_SET_QUOTA_AND_FREQUENCY_AD_UNIT_NOT_BE_NULL_WHEN_ACCELERATED_AND_USER_AUTO_FREQUENCY_NOT_SET | When neither accelerated delivery nor automatic impression frequency is set, the impression frequency and impression unit must not be empty. |
| AD__AD_SET_QUOTA_AND_FREQUENCY_AD_UNIT_SHOULD_BE_NULL_WHEN_ACCELERATED_SET | When accelerated delivery is set, the impression frequency and impression unit must be empty. |
| AD__AD_SET_QUOTA_AND_FREQUENCY_AD_UNIT_SHOULD_BE_NULL_WHEN_USE_AUTO_FREQUENCY_SET | When automatic impression frequency is set, the impression frequency and impression unit must be empty. |
| AD__AD_SET_QUOTA_OR_CREATIVE_QUOTA_SHOULD_BE_NULL | Only one of the ad group-level impression frequency and the creative-level impression frequency can be set. |
| AD__AD_SET_QUOTA_VALUE_SHOULD_BE_BETWEEN_1_TO_5 | The impression frequency can be set only to a value from 1 to 5. |
| AD__AD_SET_START_TIME_SHOULD_NOT_BE | The start time must not be empty. |
| AD__AD_SET_START_TIME_SHOULD_BE_AT_LEAST_AFTER_30_MINUTES | The start time must be at least 30 minutes after the current time. |
| AD__AD_SET_START_TIME_SHOULD_BE_BEFORE_THAN_END_TIME | The start time must be earlier than the end time. |
| AD__AD_SET_END_TIME_SHOULD_BE_NULL_WHEN_ONGOING_IS_SET | When the delivery period is set to ongoing, the end time must be empty. |
| AD__AD_SET_END_TIME_SHOULD_NOT_BE_NULL_WHEN_ONGOING_IS_NOT_SET | When the delivery period is not set to ongoing, the end time must not be empty. |
| AD__AD_SET_BID_TYPE_NOT_NULL | The billing basis must not be empty. |
| AD__AD_SET_BID_GOAL_NOT_NULL | The bidding strategy must not be empty. |
| AD__AD_SET_BID_STRATEGY_NOT_NULL | The cost management must not be empty. |
| AD__AD_SET_BUDGET_TYPE_NOT_NULL | The budget type must not be empty. |
| AD__AD_SET_MUST_BE_10_UNIT | Must be entered in units of 10. Input value: {inputValue} |
| AD__AD_SET_MUST_BE_0_01_UNIT | Must be entered in units of 0.01. Input value: {inputValue} |
| AD__AD_SET_INVALID_CURRENCY | The currency is not defined. Input value: {inputValue} |
| AD__AD_SET_BID_GOAL_NOT_COMPATIBLE_WITH_CAMPAIGN_OBJECTIVE | The bidding strategy ({bidGoal}) is not compatible with the campaign objective ({objective}). |
| AD__AD_SET_BID_STRATEGY_NOT_COMPATIBLE_WITH_CAMPAIGN_OBJECTIVE_AND_BID_GOAL | The cost management ({bidStrategy}) is not compatible with the campaign objective ({objective}) and bidding strategy ({bidGoal}). |
| AD__AD_SET_BID_TYPE_NOT_COMPATIBLE_WITH_CAMPAIGN_OBJECTIVE_AND_BID_GOAL | The billing basis ({bidType}) is not compatible with the campaign objective ({objective}) and bidding strategy ({bidGoal}). |
| AD__AD_SET_BID_STRATEGY_VALUE_SHOULD_BE_NULL | When the cost management is {bidStrategy}, the cost management value must be empty. |
| AD__AD_SET_BID_STRATEGY_VALUE_SHOULD_NOT_BE_NULL | When the cost management is {bidStrategy}, the cost management value must not be empty. |
| AD__AD_SET_BID_PRICE_SHOULD_NOT_BE_NULL | When the cost management is {bidStrategy}, the bid amount must not be empty. |
| AD__AD_SET_BID_PRICE_SHOULD_BE_NULL | When the cost management is {bidStrategy}, the bid amount must be empty. |
| AD__AD_SET_BID_STRATEGY_UNKNOWN_TYPE | The bidding strategy ({bidGoal}) is an unknown type. |
| AD__AD_SET_CANNOT_CHANGE_DIFFERENT_BUDGET_TYPE | Different budget types cannot be modified together. |
| AD__AD_SET_CANNOT_CHANGE_DIFFERENT_BID_STRATEGY | Different cost management settings cannot be modified together. |
| AD__AD_SET_CANNOT_CHANGE_DIFFERENT_BID_TYPE | Different billing bases cannot be modified together. |
| AD__AD_SET_BID_GOAL_MUST_SAME_AT_CBO | The bidding strategy of an ad group in a campaign budget optimization campaign must be the same as the campaign optimization option. |
| AD__AD_SET_BID_STRATEGY_MUST_SAME_AT_CBO | The cost management of an ad group in a campaign budget optimization campaign must be the same as the campaign optimization option. |
| AD__AD_SET_BUDGET_AMOUNT_CANNOT_BE_SET_AT_CBO | The budget of an ad group in a campaign budget optimization campaign cannot be set. |
| AD__AD_SET_BUDGET_TYPE_MUST_BE_DAILY_AT_CBO | For an ad group in a campaign budget optimization campaign, only the daily budget type can be selected. |
| AD__AD_SET_BID_TYPE_MUST_BE_CPC_AT_CBO | For an ad group in a campaign budget optimization campaign, only CPC can be selected as the billing basis. |
| AD__AD_SET_MAX_AD_SET_AT_CBO | The number of ad groups in a campaign budget optimization campaign is limited to n. |
| AD__CREATIVE_CANNOT_CREATE_EXCEED_MAX | Cannot create a new ad because the maximum number of ads has been reached. |
| AD__TARGETING_CANNOT_SET_AGE | Targeting cannot be set for this age. - Adult targeting cannot include minor ages. |
| AD__BID_STRATEGY_COST_CAP_NEED_AGREE | Agreement is required to use the cost limit. - You only need to agree once per ad account number. - How to agree: Go to gfa.naver.com, select this option when creating an ad group, check the agreement box, and save. |
| AD__BID_STRATEGY_NO_CAP_NEED_AGREE | Agreement is required to use no bid amount limit. - You only need to agree once per ad account number. - How to agree: Go to gfa.naver.com, select this option when creating an ad group, check the agreement box, and save. |
| AD__START_TIME_CANNOT_CHANGE_IN_OPERATION | The start date and time cannot be modified when the ad is running or has ended. |
| COMMON__FILE_NOT_EXIST | The file does not exist. |
| COMMON__FILE_EXTENSION_NOT_ALLOWED | The file extension is not allowed. |
| STATS__INVALID_API_VERSION | The API version is invalid. |
| STATS__INVALID_AD_ACCOUNT_NO | adAccountNo is invalid. |
| STATS__INVALID_CAMPAIGN_NO | campaignNo is invalid. |
| STATS__INVALID_AD_SET_NO | adSetNo is invalid. |
| STATS__INVALID_AGGREGATION_TYPE | aggregationType is invalid. |
| STATS__MISSING_START_DATE | startDate is missing. |
| STATS__INVALID_START_DATE | startDate is invalid. |
| STATS__INCONSISTENT_START_DATE | startDate differs from the previous request. |
| STATS__TOO_EARLY_START_DATE | Data can be retrieved for up to the past 2 years. |
| STATS__MISSING_END_DATE | endDate is missing. |
| STATS__INVALID_END_DATE | endDate is invalid. |
| STATS__INCONSISTENT_END_DATE | endDate differs from the previous request. |
| STATS__TOO_EARLY_END_DATE | endDate must be after startDate. |
| STATS__TOO_LATE_END_DATE | endDate must be before today. |
| STATS__ACCESS_BEFORE_AVAILABLE | Yesterday's data can be retrieved after 02:00. |
| STATS__TOO_LONG_PERIOD | The retrieval period is up to 31 days. |
| STATS__INVALID_NEXT | next is invalid. |
| STATS__EXPIRED_PAGING_TOKEN | The paging token has expired. |
| STATS__INCONSISTENT_LIMIT | limit differs from the previous request. |
| STATS__TOO_LARGE_LIMIT | The maximum value of limit is 1000. |
| STATS__INVALID_LIMIT | limit is invalid. |
| STATS__INVALID_TARGET_DATE | targetDate is invalid. |
| STATS__INCONSISTENT_TIME_UNIT | timeUnit differs from the previous request. |
| STATS__INVALID_TIME_UNIT | timeUnit is invalid. |
| STATS__INVALID_SINCE | since is invalid. |
| STATS__UNAUTHORIZED_EXCEPTION | Authentication of the performance retrieval permission failed. |
| STATS__FORBIDDEN | You do not have permission to retrieve this ad account. |
| STATS__INVALID_REQUEST | The request is invalid. |
| STATS__UNCAUGHT_EXCEPTION | A server error occurred. |