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
code
means. - 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
detailCode
means. - You can find how to troubleshoot each error.
Code | Description |
---|---|
AD__BID_STRATEGY_VALUE_OUT_OF_RANGE | The bidStrategy field value is outside the valid range. |
AD__BID_PRICE_OUT_OF_RANGE | The bidPrice field value is outside the valid range. |
AD__AD_SET_BUDGET_OUT_OF_RANGE | The adSetBudget field value is outside the valid range. |
AD__AD_SET_CANNOT_CREATE_EXCEED_MAX | The maximum number of ad groups has been reached. No additional ad groups can be created. |
AD__AD_SET_CANNOT_SELECT | The ad group cannot be selected. |
AD__AD_SET_GENDER_MUST_BE_SELECTED_AT_LEAST_ONE | The genders field must specify at least one option (excluding non-qualified cases). |
AD__AD_SET_NOT_EXIST | The ad group information does not exist. |
AD__AD_SET_CAMPAIGN_NOT_EXIST | The campaign information associated with the ad group does not exist. |
AD__AD_SET_CANNOT_CREATE | An ad group cannot be created. |
AD__AD_SET_TARGETING_TYPE_NOT_NULL | targetingType must not be empty. |
AD__AD_SET_INVALID_NAME_FORMAT | The ad group name must be between 2 and 128 characters in length. |
AD__AD_SET_CONTEXT_TARGETING_TYPE_NOT_AVAILABLE_CAMPAIGN_OBJECTIVE | The [contextual] targeting type is not available in an ad group 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 targets are available only for catalog campaign ads. |
AD__AD_SET_INCLUDE_FEED_AUTO_TARGETING_NOT_SUPPORTED_SHOPPING_CAMPAIGN | Whether to expand auto targeting of feed ads cannot be set in a Shopping campaign. |
AD__AD_SET_NOT_ALLOWED | Unauthorized 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 | Unauthorized to access potential customer information. |
AD__AD_SET_CUSTOM_TARGET_CANNOT_INCLUDE_SEED_COUNT | Exclusion from the target is the only option for the population. |
AD__AD_SET_CUSTOM_TARGET_CANNOT_USE | The potential customer information is not available or has been deleted. |
AD__AD_SET_CUSTOM_TARGET_EXCEED_MAX | The maximum number of potential customers for each ad group has been exceeded. |
AD__AD_SET_CUSTOM_TARGET_NOT_EXIST | The potential customer information does not exist. |
AD__AD_SET_CUSTOM_TARGET_DISABLED | Potential customers are disabled. |
AD__AD_SET_CUSTOM_TARGET_COUNT_EXCEEDED | Up to n targets can be added. Before adding a new target, please delete any unused ones. |
AD__AD_SET_CUSTOM_TARGET_NOT_AVAILABLE | Potential customers are not available. |
AD__AD_SET_CUSTOM_TARGET_FILE_COUNT_EXCEEDED | Up to 50 customer files can be added. Before adding a new customer file, please delete any unused files. |
AD__AD_SET_CUSTOM_TARGET_CONNECTED_CANNOT_BE_REMOVED | The target cannot be deleted. It is in use by an ad group. To delete the target, you need to first delete it from the potential customer settings of the ad group displayed in the target usage. |
AD__AD_SET_CUSTOM_TARGET_CONNECTED_LOOKALIKE_CANNOT_BE_REMOVED | The target cannot be deleted. It is in use by a lookalike target. To delete the target, you need to first delete the lookalike target that has been created from this target. |
AD__AD_SET_CUSTOM_TARGET_NEED_MORE_COUNT | The target population must be at least n to select targets. |
AD__AD_SET_CANNOT_SET_SOME_TARGETINGS | The specified targeting option is not available for the medium. |
AD__AD_SET_CUSTOM_TARGET_MAT_TARGETS_WITH_SAME_CONDITIONS_EXIST | MAT targets created under the same conditions such as stores, events to collect, and collection period already exist. |
AD__AD_SET_CUSTOM_TARGET_MAT_CODE_UNREMOVABLE | This conversion key is already connected and thus cannot be deleted. |
AD__AD_SET_CUSTOM_TARGET_MAT_CODE_COUNT_EXCEEDED | The maximum number of conversion keys that can be created has been exceeded. |
AD__AD_SET_CUSTOM_TARGET_LOOKALIKE_COUNT_EXCEEDED | Up to n “lookalike targets” can be added. To add a new “lookalike target,” please delete any unused ones. |
AD__AD_SET_CUSTOM_TARGET_LOOKALIKE_SAME_CONDITIONS_EXIST | A lookalike target with the same target size cannot be created for the same seed target. Please check and try again. |
AD__AD_SET_CUSTOM_TARGET_INVALID_CAMPAIGN_OBJECTIVE | NAVER Shopping targets cannot be configured for an ad group under the current campaign objective. Please check the potential customer settings of the ad group. |
AD__AD_SET_CUSTOM_TARGET_INVALID_CAMPAIGN_URL | Some NAVER Shopping targets cannot be configured due to an invalid campaign URL. Please check the potential customer settings of the ad group. |
AD__AD_SET_CUSTOM_TARGET_CANNOT_USE_AT_CONTEXT | A potential customer target cannot be configured for the [contextual] targeting type. |
AD__AD_SET_CANNOT_TARGET_AIPL_BY_CAMPAIGN_OBJECTIVE | A customer journey target cannot be configured for the engagement and app conversion campaigns. |
AD__AD_SET_CANNOT_TARGET_AIPL_BY_BIZ_CHANNEL | A customer journey target is available only when the online store type is “smart store/brand store,” or “CPC/CPS” with the brandAnalytics permission. |
AD__AD_SET_DEMOGRAPHIC_AGE_RANGE_INVALID | The age range is invalid. The valid range is as follows: {age range} |
AD__AD_SET_DEMOGRAPHIC_AGE_RANGE_UNKNOWN_MUST_BE_WITH_OTHER | At least one age range must be selected (excluding non-qualified cases). |
AD__AD_SET_DEMOGRAPHIC_ADULT_ONLY_CANNOT_EDIT | When targeting adults as the demographic, this setting cannot be disabled. |
AD__AD_SET_DEMOGRAPHIC_TARGET_CANNOT_USE_AT_CONTEXT | A demographic target cannot be configured for the [contextual] targeting type. |
AD__AD_SET_EXTENDED_DEMOGRAPHIC_TARGET_CANNOT_USE_AT_CONTEXT | An extension demo target cannot be configured for the [contextual] targeting type. |
AD__AD_SET_ADULT_ONLY_TARGET_CANNOT_USE_AT_CONTEXT | Targeting adults is not supported for the [contextual] targeting type. |
AD__AD_SET_EXTENDED_DEMO_CODE_INVALID | The extension demo target code ({code}) is invalid. |
AD__AD_SET_INTEREST_INTERSECTION_INVALID | The targeting matching method can be configured when both interest targeting and purchase intention targeting are defined. |
AD__AD_SET_INTEREST_DEPTH_INVALID | The depth of interest targeting is limited to 1, 2, 3, and 4. |
AD__AD_SET_INTEREST_TARGET_CANNOT_USE_AT_CONTEXT | An interest target cannot be configured for the [contextual] targeting type. |
AD__AD_SET_PURCHASE_INTENT_TARGET_CANNOT_USE_AT_CONTEXT | A purchase intention target cannot be configured for the [contextual] targeting type. |
AD__AD_SET_INTEREST_FIRST_CODE_INVALID | The interest target code ({code}) at the first depth is invalid. |
AD__AD_SET_INTEREST_SECOND_CODE_INVALID | The interest target code ({code}) at the second depth is invalid. |
AD__AD_SET_INTEREST_THIRD_CODE_INVALID | The interest target code ({code}) at the third depth is invalid. |
AD__AD_SET_INTEREST_FOURTH_CODE_INVALID | The interest target code ({code}) at the fourth depth is invalid. |
AD__AD_SET_INTEREST_CODE_NOT_SET | An interest target code has not been set. |
AD__AD_SET_PURCHASE_INTENT_CODE_INVALID | The purchase intention target code ({code}) is invalid. |
AD__AD_SET_DEVICE_DEVICE_TYPE_NOT_EMPTY | The devices field must not be empty. |
AD__AD_SET_DEVICE_MOBILE_NEED | When either "ANDROID" or "IOS" is configured in the platforms field, "MOBILE" must be configured in the devices field. |
AD__AD_SET_DEVICE_PLATFORMS_NOT_EMPTY | When "MOBILE" is configured in the devices field, the platforms field must not be empty; either "ANDROID" or "IOS" should be configured. |
AD__AD_SET_DEVICE_INVALID_PLATFORMS | The platform is invalid. |
AD__AD_SET_DEVICE_INVALID_PLATFORMS_ALL_DEVICE | If all devices are selected, all their platforms must be specified. |
AD__AD_SET_DEVICE_INVALID_DEVICES_ALL_DEVICE | If all devices are selected, all the devices that can be selected must be specified. |
AD__AD_SET_DEVICE_INVALID_DEVICE_TYPES | The device is invalid. |
AD__AD_SET_NOT_ALLOWED_ALL_PLACEMENT | No eligible ad placements are available. Only the list of placements [{placementGroupCodes}] can be selected for the list of devices [{deviceCodes}] that you’ve entered. |
AD__AD_SET_PLACEMENT_GROUP_NOT_EMPTY | placementGroupCodes 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}) or device ({deviceCode}). |
AD__AD_SET_PLACEMENT_GROUP_NOT_AVAILABLE_WITH_EXTERNAL_SHOPPING_MALL | A placement code (NAVER Shopping area) is not compatible with an external biz channel. |
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 | includeUnknownLocation is available only when location targets have been configured. |
AD__AD_SET_LOCATION_TARGET_CANNOT_USE_AT_CONTEXT | A location target cannot be configured for the [contextual] targeting type. |
AD__AD_SET_MUST_INCLUDE_LOCATION_AT_NEARBY | To expand nearby locations, areas of interest must be included. |
AD__AD_SET_LOCATION_TARGET_EXCEED_MAX | Up to 1,000 location targets can be configured. |
AD__AD_SET_LOCATION_TARGET_INVALID_RCODE | The location code ({locationCode}) is invalid. |
AD__AD_SET_CONTEXTUAL_TARGETING_CAN_ONLY_CONTEXT_TARGETING | A topic target is available only for the [contextual] 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 have a value between 1 and 7. |
AD__AD_SET_INVALID_TIME_FORMAT_HOUR | The startTime or endTime field must have a value between 0 and 23. |
AD__AD_SET_TIME_SLOT_MUST_BE_SET_AT_ADULT_ONLY_AND_SOME_PLACEMENT_GROUP | scheduleTimeSlots must be specified when the target audience is adults and the placements of Smart channel, Service integration, and Feed area are selected. |
AD__AD_SET_TIME_SLOT_NOT_ALLOWED_ADULT_ONLY | The detailed schedule is not available when the target audience is adults. |
AD__AD_SET_END_TIME_SHOULD_NOT_BE_NULL_WHEN_BUDGET_TYPE_IS_TOTAL | If budgetType is “TOTAL,” endTime cannot be empty. |
AD__AD_SET_ACCELERATED_OPTION_NOT_COMPATIBLE_WITH_AUTO_BID | When Auto Bidding is enabled, accelerated is not available. |
AD__AD_SET_QUOTA_AND_FREQUENCY_AD_UNIT_NOT_BE_NULL_WHEN_ACCELERATED_AND_USER_AUTO_FREQUENCY_NOT_SET | If accelerated or useAutoFrequency is false, quota and frequencyAdUnit must not be empty. |
AD__AD_SET_QUOTA_AND_FREQUENCY_AD_UNIT_SHOULD_BE_NULL_WHEN_ACCELERATED_SET | If accelerated is true, quota and frequencyAdUnit must be empty. |
AD__AD_SET_QUOTA_AND_FREQUENCY_AD_UNIT_SHOULD_BE_NULL_WHEN_USE_AUTO_FREQUENCY_SET | If useAutoFrequency is true, quota and frequencyAdUnit must be empty. |
AD__AD_SET_QUOTA_OR_CREATIVE_QUOTA_SHOULD_BE_NULL | Either an ad group- or a creative-based impression quota, but not both, can be specified. |
AD__AD_SET_QUOTA_VALUE_SHOULD_BE_BETWEEN_1_TO_5 | quota can have a value between 1 and 5. |
AD__AD_SET_START_TIME_SHOULD_NOT_BE | startTime 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 | If ongoing is true, endTime must be empty. |
AD__AD_SET_END_TIME_SHOULD_NOT_BE_NULL_WHEN_ONGOING_IS_NOT_SET | If ongoing is false, endTime must not be empty. |
AD__AD_SET_BID_TYPE_NOT_NULL | bidType cannot be empty. |
AD__AD_SET_BID_GOAL_NOT_NULL | bidGoal cannot be empty. |
AD__AD_SET_BID_STRATEGY_NOT_NULL | bidStrategy cannot be empty. |
AD__AD_SET_BUDGET_TYPE_NOT_NULL | budgetType cannot be empty. |
AD__AD_SET_MUST_BE_10_UNIT | The value must be in increments of 10. Input value: {inputValue} |
AD__AD_SET_MUST_BE_0_01_UNIT | The value must be in increments of 0.01. Input value: {inputValue} |
AD__AD_SET_INVALID_CURRENCY | The currency is undefined. Input value: {inputValue} |
AD__AD_SET_BID_GOAL_NOT_COMPATIBLE_WITH_CAMPAIGN_OBJECTIVE | The bid 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 option ({bidStrategy}) is not compatible with the campaign objective ({objective}) and bid strategy ({bidGoal}). |
AD__AD_SET_BID_TYPE_NOT_COMPATIBLE_WITH_CAMPAIGN_OBJECTIVE_AND_BID_GOAL | The billing type ({bidType}) is not compatible with the campaign objective ({objective}) and bid strategy ({bidGoal}). |
AD__AD_SET_BID_STRATEGY_VALUE_SHOULD_BE_NULL | If bidStrategy is {bidStrategy}, bidStrategyValue must be empty. |
AD__AD_SET_BID_STRATEGY_VALUE_SHOULD_NOT_BE_NULL | If bidStrategy is {bidStrategy}, bidStrategyValue must not be empty. |
AD__AD_SET_BID_PRICE_SHOULD_NOT_BE_NULL | If bidStrategy is {bidStrategy}, bidPrice must not be empty. |
AD__AD_SET_BID_PRICE_SHOULD_BE_NULL | If bidStrategy is {bidStrategy}, bidPrice mut be empty. |
AD__AD_SET_BID_STRATEGY_UNKNOWN_TYPE | The bid strategy ({bidGoal}) is an unknown type. |
AD__AD_SET_CANNOT_CHANGE_DIFFERENT_BUDGET_TYPE | Different budget types cannot be modified. |
AD__AD_SET_CANNOT_CHANGE_DIFFERENT_BID_STRATEGY | Different cost management options cannot be modified. |
AD__AD_SET_CANNOT_CHANGE_DIFFERENT_BID_TYPE | Different billing types cannot be modified. |
AD__AD_SET_BID_GOAL_MUST_SAME_AT_CBO | The bid strategy for an ad group in the CBO campaign must be the same as the CBO option. |
AD__AD_SET_BID_STRATEGY_MUST_SAME_AT_CBO | The cost management option for an ad group in the CBO campaign must be the same as the CBO option. |
AD__AD_SET_BUDGET_AMOUNT_CANNOT_BE_SET_AT_CBO | The budget for an ad group in the CBO campaign cannot be set. |
AD__AD_SET_BUDGET_TYPE_MUST_BE_DAILY_AT_CBO | Only “DAILY” can be selected for budgetType of an ad group in the CBO campaign. |
AD__AD_SET_BID_TYPE_MUST_BE_CPC_AT_CBO | Only “CPC” can be selected for bidType of an ad group in the CBO campaign. |
AD__AD_SET_MAX_AD_SET_AT_CBO | The CBO campaign can have up to n ad groups. |
AD__CREATIVE_CANNOT_CREATE_EXCEED_MAX | The maximum number of creatives has been reached. No additional creatives can be created. |
AD__TARGETING_CANNOT_SET_AGE | Targeting options are not available for this age group. - When target audiences are adults, minors cannot be included. |
AD__BID_STRATEGY_COST_CAP_NEED_AGREE | Consent must be obtained when the bidStrategy field value is set to COST_CAP. - Consent is needed only once based on the same ad account number. - How to obtain consent: Sign in to "gfa.naver.com" and then select the option when creating an ad group. |
AD__BID_STRATEGY_NO_CAP_NEED_AGREE | Consent must be obtained when the bidStrategy field value is set to NO_CAP. - Consent is needed only once based on the same ad account number. - How to obtain consent: Sign in to "gfa.naver.com" and then select the option when creating an ad group. |
AD__START_TIME_CANNOT_CHANGE_IN_OPERATION | Start date and time cannot be changed when an ad is running or when it reaches its end date. |
COMMON__FILE_NOT_EXIST | The file does not exist. |
COMMON__FILE_EXTENSION_NOT_ALLOWED | The file extension is not supported. |
STATS__INVALID_API_VERSION | The API version is not valid. |
STATS__INVALID_AD_ACCOUNT_NO | The adAccountNo field value is not valid. |
STATS__INVALID_CAMPAIGN_NO | The campaignNo field value is not valid. |
STATS__INVALID_AD_SET_NO | The adSetNo field value is not valid. |
STATS__INVALID_AGGREGATION_TYPE | The aggregationType field value is not valid. |
STATS__MISSING_START_DATE | The startDate field value is missing. |
STATS__INVALID_START_DATE | The startDate field value is not valid. |
STATS__INCONSISTENT_START_DATE | The startDate field value does not match an existing request. |
STATS__TOO_EARLY_START_DATE | Only data from the past two years can be retrieved. |
STATS__MISSING_END_DATE | The endDate field value is missing. |
STATS__INVALID_END_DATE | The endDate field value is not valid. |
STATS__INCONSISTENT_END_DATE | The endDate field value does not match an existing request. |
STATS__TOO_EARLY_END_DATE | The endDate must be after than the startDate. |
STATS__TOO_LATE_END_DATE | The endDate must be before today. |
STATS__ACCESS_BEFORE_AVAILABLE | Data from the previous day is available for retrieval beginning at 2 AM. |
STATS__TOO_LONG_PERIOD | The data retrieval period is limited to 31 days. |
STATS__INVALID_NEXT | The next field value is not valid. |
STATS__EXPIRED_PAGING_TOKEN | Page token has expired. |
STATS__INCONSISTENT_LIMIT | The limit field value does not match an existing request. |
STATS__TOO_LARGE_LIMIT | The limit field value must not exceed 1000. |
STATS__INVALID_LIMIT | The limit field value is not valid. |
STATS__INVALID_TARGET_DATE | The targetDate field value is not valid. |
STATS__INCONSISTENT_TIME_UNIT | The timeUnit field value does not match an existing request. |
STATS__INVALID_TIME_UNIT | The timeUnit field value is not valid. |
STATS__INVALID_SINCE | The since field value is not valid. |
STATS__UNAUTHORIZED_EXCEPTION | Failed to authenticate the request. |
STATS__FORBIDDEN | No authorization for retrieving the ad account. |
STATS__INVALID_REQUEST | The request is not valid. |
STATS__UNCAUGHT_EXCEPTION | Server error |