# LINE Ads Platform Management API reference

This feature is only available to corporate customers

This feature is only available to corporate customers. For more information, contact your LINE representative or make an inquiry through LINE for Business (opens new window). For details, refer to LINE Ads Platform (opens new window).

# Common specifications

# Rate limits

The limitation for the number of requests you can make for each API are shown below. The limitation is applied for each API user.

Limit
10 requests per sec

# Error status codes and responses

The following status codes and array of Error are returned as errors when an error occurs.

Status code Description
400 Problem with the request
401 The token specified in 'Authorization' header is invalid.
403 Not authorized to use the API. Confirm that your account is authorized to used the API.
429 Exceeded the rate limit for API calls
500 Error on the internal server

# Resources

# AuthorityDelegations

This API enables to request that the account delegates the authority to access to resources.

# get

Get your requests to an account to delegate an authority.

# HTTP request

POST https://ads.line.me/api/v2.0/authority_delegations/get

# Request headers

Content-Type

application/json

# Request body

sourceGroupId

String

Optional

Id of the group which is requesting for delegating authority.
Default value is your root group id.

sortKey

Enum (ID, ACCOUNT_ID, APPROVAL_STATUS)

Optional

The key to sort the result

sortType

Enum (ASC, DESC)

Optional

The order to sort the result

page

Number

Optional

The number of page

results

Number

Optional

The number of results to return.
Minimum value : 1
Maximum value : 500

# Response

Returns status code 200 and AuthorityDelegations JSON object.

# add

Create requests to an account to delegate an authority.

# HTTP request

POST https://ads.line.me/api/v2.0/authority_delegations/add

# Request headers

Content-Type

application/json

# Request body

sourceGroupId

String

Optional
read-only

Id of the group which is requesting for delegating authority.
Default value is your root group id.

operands

Array

Required

List of AuthorityDelegationAdd as shown in the table below

operands[].id

Number

Optional

Id of this authority delegation

operands[].sourceGroupId

String

Optional
read-only

Id of the group which is requesting for delegating authority.
Default value is your root group id.

operands[].accountId

String

Required

Id of the account to be requested delegating authority

operands[].approvalStatus

Enum (WAITING_APPROVAL, REJECTED, LINKED, CANCELED, UNLINKED, REVOKED)

Optional
read-only

The status of approval by account requested to delegate authority

operands[].requestedDateUtc

String

Optional
read-only

The date of requested delegate authority (in UTC)

operands[].approvedDateUtc

String

Optional
read-only

The date that the account approved this request (in UTC)

operands[].errors

Array of Error

Optional
read-only

This field exists when errors occurred only.

# Response

Returns status code 200 and AuthorityDelegations JSON object.

# remove

Terminate requests to an account to delegate an authority. Once terminated requests cannot be recovered.

# HTTP request

POST https://ads.line.me/api/v2.0/authority_delegations/remove

# Request headers

Content-Type

application/json

# Request body

operands

Array

Required

List of AuthorityDelegationRemove as shown in the table below

operands[].id

Number

Required

Id of this authority delegation

# Response

Returns status code 200 and AuthorityDelegations JSON object.

# Groups

# get

Get groups.

# HTTP request

POST https://ads.line.me/api/v2.0/groups/get

# Request headers

Content-Type

application/json

# Request body

parentGroupId

String

Optional

The id of parent group.
Default value is your root group id.

sortKey

Enum (ID, NAME, UPDATED_DATE)

Optional

The key to sort the result.

removed

Boolean

Optional

The value whether including removed groups or not in the result.
Default : false

linked

Boolean

Optional

If true, the result includes all child groups of the parent group.
If false, the result includes direct child groups of the parent group.
Default : true

sortType

Enum(ASC, DESC)

Optional

The order to sort the result.

page

Number

Optional

The number of page.

results

Number

Optional

The number of results to return.
Minimum value : 1
Maximum value : 500

# Response

Returns the status code 200 and a JSON object with these properties:

operands

Array of Group

Required

List of Group

# add

Add child group to parent group.

# HTTP request

POST https://ads.line.me/api/v2.0/groups/add

# Request headers

Content-Type

application/json

# Request body

parentGroupId

String

Optional

The id of parent group.
Default value is your root group id.

operands

Array

Optional

List of groups to add (GroupAdd as shown in the table below)
Size: 1 - 100

operands[].id

String

Optional

The id of this group.

operands[].name

String

Required

The name of this group.

operands[].parentGroupId

String

Optional
read-only

The id of parent group.

operands[].parentGroupName

String

Optional
read-only

The name of parent group.

operands[].depth

Number

Optional
read-only

The number of ancestor groups.

operands[].createdDate

String

Optional
read-only

Created date of this group.
Date timezone is Asia/Tokyo(UTC+9).
Pattern : "YYYYMMDD HH:mm:ss"

operands[].updatedDate

String

Optional
read-only

Last updated date of this group.
Date timezone is Asia/Tokyo(UTC+9).
Pattern : "YYYYMMDD HH:mm:ss"

operands[].errors

Array of Error

Optional
read-only

This field exists when errors occurred only.

# Response

Returns the status code 200 and a JSON object with these properties:

operands

Array of Group

Required

List of Group

# set

Modify only name of group

# HTTP request

POST https://ads.line.me/api/v2.0/groups/set

# Request headers

Content-Type

application/json

# Request body

operands

Array

Optional

List of groups to set. (GroupSet as shown in the table below)
Size: 1 - 100

operands[].id

String

Required

The id of this group.

operands[].name

String

Optional

The name of this group.

operands[].parentGroupId

String

Optional
read-only

The id of parent group.

operands[].parentGroupName

String

Optional
read-only

The name of parent group.

operands[].depth

Number

Optional
read-only

The number of ancestor groups.

operands[].createdDate

String

Optional
read-only

Created date of this group.
Date timezone is Asia/Tokyo(UTC+9).
Pattern : "YYYYMMDD HH:mm:ss"

operands[].updatedDate

String

Optional
read-only

Last updated date of this group.
Date timezone is Asia/Tokyo(UTC+9).
Pattern : "YYYYMMDD HH:mm:ss"

operands[].errors

Array of Error

Optional
read-only

This field exists when errors occurred only.

# Response

Returns the status code 200 and a JSON object with these properties:

operands

Array of Group

Required

List of Group

# Accounts

# get

Get Accounts.

# HTTP request

POST https://ads.line.me/api/v2.0/accounts/get

# Request headers

Content-Type

application/json

# Request body

sortType

Enum (ASC, DESC)

Optional

The order to sort the result

page

Number

Optional

The number of page

results

Number

Optional

The number of results to return.
Minimum value : 1
Maximum value : 500

sortKey

Enum (ID, NAME, USER_STATUS, CURRENCY, TIMEZONE)

Optional

The key to sort the result

# Response

Returns status code 200 and a JSON object with these properties:

operands

Array of Account

Required

List of Account

# Campaigns

# get

Get campaigns.

# HTTP request

POST https://ads.line.me/api/v2.0/campaigns/get

# Request headers

Content-Type

application/json

# Request body

accountId

String

Required

Id of the account

sortKey

Enum (ID, NAME, USER_STATUS, CAMPAIGN_OBJECTIVE_TYPE, SPENDING_LIMIT, START_DATE, END_DATE, UPDATED_DATE)

Optional

The key to sort the result

ids

Array of number

Optional

Filtering data by those specified ids

removed

Boolean

Optional

The value whether including removed data or not in the result

sortType

Enum (ASC, DESC)

Optional

The order to sort the result

page

Number

Optional

The number of page

results

Number

Optional

The number of results to return.
Minimum value : 1
Maximum value : 500

# Response

Returns status code 200 and Campaigns JSON object.

# add

Create campaigns.

# HTTP request

POST https://ads.line.me/api/v2.0/campaigns/add

# Request headers

Content-Type

application/json

# Request body

accountId

String

Required

Id of the account

operands

Array

Required

List of CampaignAdd as shown in the table below

operands[].id

Number

Optional

Id of this campaign

operands[].name

String

Required

Name of this campaign
Length : 1 - 120

operands[].campaignObjectiveType

Enum (VISIT_MY_WEBSITE, APP_INSTALL, APP_ENGAGEMENT, WEBSITE_CONVERSION, DYNAMIC_PRODUCT, GAIN_FRIENDS)

Required

The objective of this campaign.
This field will be ignored when the action is set.

operands[].userStatus

Enum (ACTIVE, PAUSED, REMOVED)

Optional

The status of this campaign.
If the entity is removed, this status becomes “REMOVED”.

operands[].deliveryStatus

Enum (ACTIVE, PAUSED, REMOVED, NOT_DELIVERING, NOT_APPROVED)

Optional
read-only

The status of delivery ad

operands[].deliveryStatusReasons

Array of enum (AD_PAUSED, ADGROUP_PAUSED, CAMPAIGN_PAUSED, ACCOUNT_PAUSED, REMOVED, AD_NOT_APPROVED, AD_BLOCKED, CREATIVE_BLOCKED, AD_IN_REVIEW, APP_NOT_APPROVED, ADGROUP_BLOCKED, APP_IN_REVIEW, CAMPAIGN_BLOCKED, CAMPAIGN_SCHEDULED, CAMPAIGN_ENDED, CAMPAIGN_SPENDING_LIMIT_OVER, CAMPAIGN_CPF_NOT_VERIFIED, NO_PRODUCT_FEED, PRODUCT_FEED_IN_REVIEW, PRODUCT_FEED_REJECTED, BILLING_NOT_APPROVED, BILLING_IN_REVIEW, BILLING_NOT_LINKED, ACCOUNT_NOT_APPROVED, ACCOUNT_BLOCKED, ACCOUNT_IN_REVIEW, ACTIVE_ADGROUP_LEARNING, ACCOUNT_SPENDING_LIMIT_OVER, LINE_ACCOUNT_NOT_EXIST, LINE_ACCOUNT_STATUS_DELETED, LINE_ACCOUNT_STATUS_IN_ACTIVE, LINE_ACCOUNT_LINK_NOT_APPROVED)

Optional
read-only

The reason of delivery status

operands[].spendingLimit

SpendingLimit

Optional

operands[].startDate

String

Optional

The date of starting to delivery ads (in local date for the account).
Pattern : "YYYYMMDD HH:mm:ss"

operands[].endDate

String

Optional

The date of suspending delivering ads (in local date for the account).
Set the word 'NONE' to this field if you want to erase endDate.
Pattern : "YYYYMMDD HH:mm:ss"

operands[].createdDate

String

Optional
read-only

The date of campaign created.
Pattern : "YYYYMMDD HH:mm:ss"

operands[].updatedDate

String

Optional
read-only

The date of campaign modified.
Pattern : "YYYYMMDD HH:mm:ss"

operands[].errors

Array of Error

Optional
read-only

This field exists when errors occurred only.

# Response

Returns status code 200 and an empty JSON object.

# set

Modify campaigns.

# HTTP request

POST https://ads.line.me/api/v2.0/campaigns/set

# Request headers

Content-Type

application/json

# Request body

accountId

String

Required

Id of the account

operands

Array

Required

List of CampaignSet as shown in the table below

operands[].id

Number

Required

Id of this campaign

operands[].name

String

Optional

Name of this campaign
Length : 1 - 120

operands[].campaignObjectiveType

Enum (VISIT_MY_WEBSITE, APP_INSTALL, APP_ENGAGEMENT, WEBSITE_CONVERSION, DYNAMIC_PRODUCT, GAIN_FRIENDS)

Optional

The objective of this campaign.
This field will be ignored when the action is set.

operands[].userStatus

Enum (ACTIVE, PAUSED, REMOVED)

Optional

The status of this campaign.
If the entity is removed, this status becomes “REMOVED”.

operands[].deliveryStatus

Enum (ACTIVE, PAUSED, REMOVED, NOT_DELIVERING, NOT_APPROVED)

Optional
read-only

The status of delivery ad

operands[].deliveryStatusReasons

Array of enum (AD_PAUSED, ADGROUP_PAUSED, CAMPAIGN_PAUSED, ACCOUNT_PAUSED, REMOVED, AD_NOT_APPROVED, AD_BLOCKED, CREATIVE_BLOCKED, AD_IN_REVIEW, APP_NOT_APPROVED, ADGROUP_BLOCKED, APP_IN_REVIEW, CAMPAIGN_BLOCKED, CAMPAIGN_SCHEDULED, CAMPAIGN_ENDED, CAMPAIGN_SPENDING_LIMIT_OVER, CAMPAIGN_CPF_NOT_VERIFIED, NO_PRODUCT_FEED, PRODUCT_FEED_IN_REVIEW, PRODUCT_FEED_REJECTED, BILLING_NOT_APPROVED, BILLING_IN_REVIEW, BILLING_NOT_LINKED, ACCOUNT_NOT_APPROVED, ACCOUNT_BLOCKED, ACCOUNT_IN_REVIEW, ACTIVE_ADGROUP_LEARNING, ACCOUNT_SPENDING_LIMIT_OVER, LINE_ACCOUNT_NOT_EXIST, LINE_ACCOUNT_STATUS_DELETED, LINE_ACCOUNT_STATUS_IN_ACTIVE, LINE_ACCOUNT_LINK_NOT_APPROVED)

Optional
read-only

The reason of delivery status

operands[].spendingLimit

SpendingLimit

Optional

operands[].startDate

String

Optional

The date of starting to delivery ads (in local date for the account).
Pattern : "YYYYMMDD HH:mm:ss"

operands[].endDate

String

Optional

The date of suspending delivering ads (in local date for the account).
Set the word 'NONE' to this field if you want to erase endDate.
Pattern : "YYYYMMDD HH:mm:ss"

operands[].createdDate

String

Optional
read-only

The date of campaign created.
Pattern : "YYYYMMDD HH:mm:ss"

operands[].updatedDate

String

Optional
read-only

The date of campaign modified.
Pattern : "YYYYMMDD HH:mm:ss"

operands[].errors

Array of Error

Optional
read-only

This field exists when errors occurred only.

# Response

Returns status code 200 and Campaigns JSON object.

# remove

Terminate campaigns. Once terminated campaign cannot be recovered and used for bidding.

# HTTP request

POST https://ads.line.me/api/v2.0/campaigns/remove

# Request headers

Content-Type

application/json

# Request body

accountId

String

Required

Id of the account

operands

Array

Required

List of CampaignRemove as shown in the table below

operands[].id

Number

Required

Id of this campaign

# Response

Returns status code 200 and Campaigns JSON object.

# AdGroups

# get

Get adgroups.

# HTTP request

POST https://ads.line.me/api/v2.0/adgroups/get

# Request headers

Content-Type

application/json

# Request body

accountId

String

Required

Id of the account

sortKey

Enum (ID, CAMPAIGN_ID, NAME, USER_STATUS, BID_TYPE, BID_AMOUNT, UPDATED_DATE)

Optional

The key to sort the result

ids

Array of number

Optional

Filtering data by those specified ids

removed

Boolean

Optional

The value whether including removed data or not in the result

sortType

Enum (ASC, DESC)

Optional

The order to sort the result

page

Number

Optional

The number of page

results

Number

Optional

The number of results to return.
Minimum value : 1
Maximum value : 500

# Response

Returns status code 200 and AdGroups JSON object.

# add

Create adgroups.

# HTTP request

POST https://ads.line.me/api/v2.0/adgroups/add

# Request headers

Content-Type

application/json

# Request body

accountId

String

Required

Id of the account

operands

Array

Required

List of AdGroupAdd as shown in the table below

operands[].id

Number

Optional

Id of this adGroup

operands[].campaignId

Number

Required

Id of campaign as parent of adGroup

operands[].mediaAppId

Number

Optional

Id of media app which you advertise

operands[].mediaApp

Media

Optional
read-only

operands[].name

String

Required

Name of this adGroup.
Length : 1 - 120

operands[].userStatus

Enum (ACTIVE, PAUSED, REMOVED)

Optional

The status of this adGroup.
If the entity is removed, this status becomes “REMOVED”.

operands[].deliveryStatus

Enum (ACTIVE, PAUSED, REMOVED, NOT_DELIVERING, NOT_APPROVED)

Optional
read-only

The status of delivery ad

operands[].deliveryStatusReasons

Array of enum (AD_PAUSED, ADGROUP_PAUSED, CAMPAIGN_PAUSED, ACCOUNT_PAUSED, REMOVED, AD_NOT_APPROVED, AD_BLOCKED, CREATIVE_BLOCKED, AD_IN_REVIEW, APP_NOT_APPROVED, ADGROUP_BLOCKED, APP_IN_REVIEW, CAMPAIGN_BLOCKED, CAMPAIGN_SCHEDULED, CAMPAIGN_ENDED, CAMPAIGN_SPENDING_LIMIT_OVER, CAMPAIGN_CPF_NOT_VERIFIED, NO_PRODUCT_FEED, PRODUCT_FEED_IN_REVIEW, PRODUCT_FEED_REJECTED, BILLING_NOT_APPROVED, BILLING_IN_REVIEW, BILLING_NOT_LINKED, ACCOUNT_NOT_APPROVED, ACCOUNT_BLOCKED, ACCOUNT_IN_REVIEW, ACTIVE_ADGROUP_LEARNING, ACCOUNT_SPENDING_LIMIT_OVER, LINE_ACCOUNT_NOT_EXIST, LINE_ACCOUNT_STATUS_DELETED, LINE_ACCOUNT_STATUS_IN_ACTIVE, LINE_ACCOUNT_LINK_NOT_APPROVED, ALL_AUDIENCE_NOT_ACTIVE, EXCLUDE_SHARED_AUDIENCE_NOT_ACTIVE)

Optional
read-only

The reason of delivery status

operands[].adGroupLearning

AdGroupLearning

Optional
read-only

operands[].bid

Bid

Required

operands[].dailyBudgetMicro

Number

Required

Daily budget in micros (in the local currency for the account)

operands[].autoBidType

Enum (MANUAL, MAXIMIZE_CLICKS, MAXIMIZE_CONVERSIONS, MAXIMIZE_INSTALLS, MAXIMIZE_FRIEND)

Optional

The type of auto bidding

operands[].targeting

Targeting

Optional

operands[].dpaDestinationType

operands[].dpaDestinationUrl

String

Optional

The url of DPA destination (DPA only)

operands[].rnfStartDate

String

Optional

Reach & Frequency’s start date.
Pattern : "YYYYMMDD HH:mm:ss"

operands[].rnfEndDate

String

Optional

Reach & Frequency’s end date.
Pattern : "YYYYMMDD HH:mm:ss"

operands[].rnfFrequency

Number

Optional

Reach & Frequency’s frequency cap.
Minimum value : 2
Maximum value : 10

operands[].createdDate

String

Optional
read-only

The date of campaign created.
Pattern : "YYYYMMDD HH:mm:ss"

operands[].updatedDate

String

Optional
read-only

The date of campaign modified.
Pattern : "YYYYMMDD HH:mm:ss"

operands[].errors

Array of Error

Optional
read-only

This field exists when errors occurred only.

# Response

Returns status code 200 and AdGroups JSON object.

# set

Modify adgroups.

# HTTP request

POST https://ads.line.me/api/v2.0/adgroups/set

# Request headers

Content-Type

application/json

# Request body

accountId

String

Required

Id of the account

operands

Array

Required

List of AdGroupSet as shown in the table below

operands[].id

Number

Required

Id of this adGroup

operands[].campaignId

Number

Optional

Id of campaign as parent of adGroup

operands[].mediaAppId

Number

Optional

Id of media app which you advertise

operands[].mediaApp

Media

Optional
read-only

operands[].name

String

Optional

Name of this adGroup.
Length : 1 - 120

operands[].userStatus

Enum (ACTIVE, PAUSED, REMOVED)

Optional

The status of this adGroup.
If the entity is removed, this status becomes “REMOVED”.

operands[].deliveryStatus

Enum (ACTIVE, PAUSED, REMOVED, NOT_DELIVERING, NOT_APPROVED)

Optional
read-only

The status of delivery ad

operands[].deliveryStatusReasons

Array of enum (AD_PAUSED, ADGROUP_PAUSED, CAMPAIGN_PAUSED, ACCOUNT_PAUSED, REMOVED, AD_NOT_APPROVED, AD_BLOCKED, CREATIVE_BLOCKED, AD_IN_REVIEW, APP_NOT_APPROVED, ADGROUP_BLOCKED, APP_IN_REVIEW, CAMPAIGN_BLOCKED, CAMPAIGN_SCHEDULED, CAMPAIGN_ENDED, CAMPAIGN_SPENDING_LIMIT_OVER, CAMPAIGN_CPF_NOT_VERIFIED, NO_PRODUCT_FEED, PRODUCT_FEED_IN_REVIEW, PRODUCT_FEED_REJECTED, BILLING_NOT_APPROVED, BILLING_IN_REVIEW, BILLING_NOT_LINKED, ACCOUNT_NOT_APPROVED, ACCOUNT_BLOCKED, ACCOUNT_IN_REVIEW, ACTIVE_ADGROUP_LEARNING, ACCOUNT_SPENDING_LIMIT_OVER, LINE_ACCOUNT_NOT_EXIST, LINE_ACCOUNT_STATUS_DELETED, LINE_ACCOUNT_STATUS_IN_ACTIVE, LINE_ACCOUNT_LINK_NOT_APPROVED, ALL_AUDIENCE_NOT_ACTIVE, EXCLUDE_SHARED_AUDIENCE_NOT_ACTIVE)

Optional
read-only

The reason of delivery status

operands[].adGroupLearning

AdGroupLearning

Optional
read-only

operands[].bid

Bid

Optional

operands[].dailyBudgetMicro

Number

Optional

Daily budget in micros (in the local currency for the account)

operands[].autoBidType

Enum (MANUAL, MAXIMIZE_CLICKS, MAXIMIZE_CONVERSIONS, MAXIMIZE_INSTALLS, MAXIMIZE_FRIEND)

Optional

The type of auto bidding

operands[].targeting

Targeting

Optional

operands[].dpaDestinationType

operands[].dpaDestinationUrl

String

Optional

The url of DPA destination (DPA only)

operands[].rnfStartDate

String

Optional

Reach & Frequency’s start date.
Pattern : "YYYYMMDD HH:mm:ss"

operands[].rnfEndDate

String

Optional

Reach & Frequency’s end date.
Pattern : "YYYYMMDD HH:mm:ss"

operands[].rnfFrequency

Number

Optional

Reach & Frequency’s frequency cap.
Minimum value : 2
Maximum value : 10

operands[].createdDate

String

Optional
read-only

The date of campaign created.
Pattern : "YYYYMMDD HH:mm:ss"

operands[].updatedDate

String

Optional
read-only

The date of campaign modified.
Pattern : "YYYYMMDD HH:mm:ss"

operands[].errors

Array of Error

Optional
read-only

This field exists when errors occurred only.

# Response

Returns status code 200 and AdGroups JSON object.

# remove

Terminate adgroups. Once terminated adgroup cannot be recovered and used for bidding.

# HTTP request

POST https://ads.line.me/api/v2.0/adgroups/remove

# Request headers

Content-Type

application/json

# Request body

accountId

String

Required

Id of the account

operands

Array

Required

List of AdGroupRemove as shown in the table below

operands[].id

Number

Required

Id of this adGroup

# Response

Returns status code 200 and AdGroups JSON object.

# Ads

# get

Get ads.

# HTTP request

POST https://ads.line.me/api/v2.0/ads/get

# Request headers

Content-Type

application/json

# Request body

accountId

String

Required

Id of the account

sortKey

Enum (ID, AD_GROUP_ID, CREATIVE_ID, NAME, USER_STATUS, UPDATED_DATE)

Optional

The key to sort the result

ids

Array of number

Optional

Filtering data by those specified ids

removed

Boolean

Optional

The value whether including removed data or not in the result

sortType

Enum (ASC, DESC)

Optional

The order to sort the result

page

Number

Optional

The number of page

results

Number

Optional

The number of results to return.
Minimum value : 1
Maximum value : 500

# Response

Returns status code 200 and Ads JSON object.

# add

Create ads.

# HTTP request

POST https://ads.line.me/api/v2.0/ads/add

# Request headers

Content-Type

application/json

# Request body

accountId

String

Required

Id of the account

operands

Array

Required

List of AdAdd as shown in the table below

operands[].id

Number

Optional

Id of this ad

operands[].adGroupId

Number

Required

Id of adGroup as parent of Ad

operands[].creative

Creative

Required

operands[].name

String

Optional

Name of this ad.
Length : 1 - 120

operands[].userStatus

Enum (ACTIVE, PAUSED, REMOVED)

Optional

The status of this ad.
If the entity is removed, this status becomes “REMOVED”.

operands[].deliveryStatus

Enum (ACTIVE, PAUSED, REMOVED, NOT_DELIVERING, NOT_APPROVED)

Optional
read-only

The status of delivery ad

operands[].deliveryStatusReasons

Array of enum (AD_PAUSED, ADGROUP_PAUSED, CAMPAIGN_PAUSED, ACCOUNT_PAUSED, REMOVED, AD_NOT_APPROVED, AD_BLOCKED, CREATIVE_BLOCKED, AD_IN_REVIEW, APP_NOT_APPROVED, ADGROUP_BLOCKED, APP_IN_REVIEW, CAMPAIGN_BLOCKED, CAMPAIGN_SCHEDULED, CAMPAIGN_ENDED, CAMPAIGN_SPENDING_LIMIT_OVER, CAMPAIGN_CPF_NOT_VERIFIED, NO_PRODUCT_FEED, PRODUCT_FEED_IN_REVIEW, PRODUCT_FEED_REJECTED, BILLING_NOT_APPROVED, BILLING_IN_REVIEW, BILLING_NOT_LINKED, ACCOUNT_NOT_APPROVED, ACCOUNT_BLOCKED, ACCOUNT_IN_REVIEW, ACTIVE_ADGROUP_LEARNING, ACCOUNT_SPENDING_LIMIT_OVER, LINE_ACCOUNT_NOT_EXIST, LINE_ACCOUNT_STATUS_DELETED, LINE_ACCOUNT_STATUS_IN_ACTIVE, LINE_ACCOUNT_LINK_NOT_APPROVED, ALL_AUDIENCE_NOT_ACTIVE, EXCLUDE_SHARED_AUDIENCE_NOT_ACTIVE)

Optional
read-only

The reason of delivery status

operands[].errors

Array of Error

Optional
read-only

This field exists when errors occurred only.

# Response

Returns status code 200 and Ads JSON object.

# set

Modify only name and userStatus of ad.

# HTTP request

POST https://ads.line.me/api/v2.0/ads/set

# Request headers

Content-Type

application/json

# Request body

accountId

String

Required

Id of the account

operands

Array

Required

List of AdSet as shown in the table below

operands[].id

Number

Required

Id of this ad

operands[].adGroupId

Number

Optional

Id of adGroup as parent of Ad

operands[].creative

Creative

Optional

operands[].name

String

Optional

Name of this ad.
Length : 1 - 120

operands[].userStatus

Enum (ACTIVE, PAUSED, REMOVED)

Optional

The status of this ad.
If the entity is removed, this status becomes “REMOVED”.

operands[].deliveryStatus

Enum (ACTIVE, PAUSED, REMOVED, NOT_DELIVERING, NOT_APPROVED)

Optional
read-only

The status of delivery ad

operands[].deliveryStatusReasons

Array of enum (AD_PAUSED, ADGROUP_PAUSED, CAMPAIGN_PAUSED, ACCOUNT_PAUSED, REMOVED, AD_NOT_APPROVED, AD_BLOCKED, CREATIVE_BLOCKED, AD_IN_REVIEW, APP_NOT_APPROVED, ADGROUP_BLOCKED, APP_IN_REVIEW, CAMPAIGN_BLOCKED, CAMPAIGN_SCHEDULED, CAMPAIGN_ENDED, CAMPAIGN_SPENDING_LIMIT_OVER, CAMPAIGN_CPF_NOT_VERIFIED, NO_PRODUCT_FEED, PRODUCT_FEED_IN_REVIEW, PRODUCT_FEED_REJECTED, BILLING_NOT_APPROVED, BILLING_IN_REVIEW, BILLING_NOT_LINKED, ACCOUNT_NOT_APPROVED, ACCOUNT_BLOCKED, ACCOUNT_IN_REVIEW, ACTIVE_ADGROUP_LEARNING, ACCOUNT_SPENDING_LIMIT_OVER, LINE_ACCOUNT_NOT_EXIST, LINE_ACCOUNT_STATUS_DELETED, LINE_ACCOUNT_STATUS_IN_ACTIVE, LINE_ACCOUNT_LINK_NOT_APPROVED, ALL_AUDIENCE_NOT_ACTIVE, EXCLUDE_SHARED_AUDIENCE_NOT_ACTIVE)

Optional
read-only

The reason of delivery status

operands[].errors

Array of Error

Optional
read-only

This field exists when errors occurred only.

# Response

Returns status code 200 and Ads JSON object.

# remove

Terminate ads. Once terminated ad cannot be recovered and used for bidding.

# HTTP request

POST https://ads.line.me/api/v2.0/ads/remove

# Request headers

Content-Type

application/json

# Request body

accountId

String

Required

Id of the account

operands

Array

Required

List of AdRemove as shown in the table below

operands[].id

Number

Required

Id of this ad

# Response

Returns status code 200 and Ads JSON object.

# Media

# get

Get media.

# HTTP request

POST https://ads.line.me/api/v2.0/media/get

# Request headers

Content-Type

application/json

# Request body

sortType

Enum (ASC, DESC)

Optional

The order to sort the result

page

Number

Optional

The number of page

results

Number

Optional

The number of results to return.
Minimum value : 1
Maximum value : 500

accountId

String

Required

Id of the account

ids

Array of number

Optional

Filtering data by those specified ids

sortKey

Enum (ID, NAME, MIME_TYPE, UPDATED_DATE)

Optional

The key to sort the result

# Response

Returns status code 200 and a JSON object with these properties:

accountId

String

Required

Id of the account

operands

Array of Media

Required

List of Media

# add

Create 'app' of media.

If would like to upload image or video, you can do it with not this API but Media upload API.

# HTTP request

POST https://ads.line.me/api/v2.0/media/add

# Request headers

Content-Type

application/json

# Request body

id

Number

Optional

Id of this media

name

String

Required

The name of this media

mediaType

Enum (IMAGE, VIDEO, APP)

Required

The type of this media

mimeType

String

Optional
read-only

The type of content of this media

width

Number

Optional
read-only

Horizontal length of this media

height

Number

Optional
read-only

Vertical length of this media

fileSize

Number

Optional
read-only

File size of this media

mediaHash

String

Optional
read-only

Hash code of this media

sourceUrl

String

Optional
read-only

The url of this media

duration

Number

Optional
read-only

Duration time of video

osName

Enum (IOS, ANDROID)

Required

The name of mobile operating system

appStoreUrl

String

Required

The url of the page for that app on store

appId

String

Required

The identifier of this App. This field can be set 'App ID' for iOS or 'Package Name' for Android.

reviewStatus

Enum (SKIPPED_REVIEW, IN_REVIEW, APPROVED, REJECTED)

Optional
read-only

Review status of this creative

createdDate

String

Optional
read-only

Created date of media
Pattern : "YYYYMMDD HH:mm:ss"

updatedDate

String

Optional
read-only

Last updated date of media
Pattern : "YYYYMMDD HH:mm:ss"

removedDate

String

Optional
read-only

Removed date of media
Pattern : "YYYYMMDD HH:mm:ss"

errors

Array of Error

Optional
read-only

This field exists when errors occurred only.

# Response

Returns status code 200 and Media JSON object.

# set

Modify only the name of media.

# HTTP request

POST https://ads.line.me/api/v2.0/media/set

# Request headers

Content-Type

application/json

# Request body

id

Number

Required

Id of this media

name

String

Required

The name of this media

mediaType

Enum (IMAGE, VIDEO, APP)

Optional

The type of this media

mimeType

String

Optional
read-only

The type of content of this media

width

Number

Optional
read-only

Horizontal length of this media

height

Number

Optional
read-only

Vertical length of this media

fileSize

Number

Optional
read-only

File size of this media

mediaHash

String

Optional
read-only

Hash code of this media

sourceUrl

String

Optional
read-only

The url of this media

duration

Number

Optional
read-only

Duration time of video

osName

Enum (IOS, ANDROID)

Optional

The name of mobile operating system

appStoreUrl

String

Optional

The url of the page for that app on store

appId

String

Optional

The identifier of this App.
This field can be set 'App ID' for iOS or 'Package Name' for Android.

reviewStatus

Enum (SKIPPED_REVIEW, IN_REVIEW, APPROVED, REJECTED)

Optional
read-only

Review status of this creative

createdDate

String

Optional
read-only

Created date of media
Pattern : "YYYYMMDD HH:mm:ss"

updatedDate

String

Optional
read-only

Last updated date of media
Pattern : "YYYYMMDD HH:mm:ss"

removedDate

String

Optional
read-only

Removed date of media
Pattern : "YYYYMMDD HH:mm:ss"

errors

Array of Error

Optional
read-only

This field exists when errors occurred only.

# Response

Returns status code 200 and Media JSON object.

# remove

Terminate media. Once terminated media cannot be recovered and used for bidding.

# HTTP request

POST https://ads.line.me/api/v2.0/media/remove

# Request headers

Content-Type

application/json

# Request body

id

Number

Required

Id of this media

# Response

Returns status code 200 and Media JSON object.

# upload

Upload a media file (image, video).

Example request

# HTTP request

POST https://ads.line.me/api/v2.0/media/upload

# Request headers

Content-Type

multipart/form-data

# Request body

accountId

String

Required

Id of the account

file

File

Required

The file content of this media

mediaType

Enum (IMAGE, VIDEO)

Required

The type of this media

# Response

Returns status code 200 and a JSON object with these properties:

accountId

String

Optional
read-only

Id of the account

result

Media

Optional
read-only

# Reports

# get

Get report jobs.

# HTTP request

POST https://ads.line.me/api/v2.0/reports/get

# Request headers

Content-Type

application/json

# Request body
Schema Required
ReportSelector Required

# ReportSelector

accountId

String

Required

Id of the account

sortKey

Enum (ID, NAME, STATUS, CREATED_DATE)

Optional

The key to sort the result

ids

Array of number

Optional

Filtering data by those specified ids

removed

Boolean

Optional

The value whether including removed data or not in the result

sortType

Enum (ASC, DESC)

Optional

The order to sort the result

page

Number

Optional

The number of page

results

Number

Optional

The number of results to return.
Minimum value : 1
Maximum value : 500

# Response

Returns status code 200 and Reports JSON object.

# add

Create report jobs.

# HTTP request

POST https://ads.line.me/api/v2.0/reports/add

# Request headers

Content-Type

application/json

# Request body

accountId

String

Required

Id of the account

operands

Array

Required

List of ReportAdd as shown in the table below

operands[].id

Number

Optional

Id of this report

operands[].name

String

Optional
read-only

Name of this report

operands[].status

Enum (CREATED, PREPARING, ERROR, READY)

Optional
read-only

The status of report creation

operands[].startDate

String

Optional

The start date to display statistics.
Pattern : "YYYYMMDD"

operands[].endDate

String

Optional

The end date to display statistics.
Pattern : "YYYYMMDD"

operands[].reportType

Enum (ACCOUNT, CAMPAIGN, AD_GROUP, AD)

Required

The type of report

operands[].breakdown

Breakdown

Optional

operands[].createdDate

String

Optional

The date of registered this report

operands[].errors

Array of Error

Optional
read-only

This field exists when errors occurred only.

# Response

Returns status code 200 and Reports JSON object.

# remove

Remove report jobs. Once terminated a job cannot be recovered.

# HTTP request

POST https://ads.line.me/api/v2.0/reports/remove

# Request headers

Content-Type

application/json

# Request body

accountId

String

Required

Id of the account

operands

Array

Required

List of ReportRemove as shown in the table below

operands[].id

Number

Required

Id of this report

# Response

Returns status code 200 and Reports JSON object.

# download

Download reports.

# HTTP request

POST https://ads.line.me/api/v2.0/reports/download

# Request headers

Content-Type

application/json

# Request body
Schema Required
ReportDownloadRequest Required
# Response

Returns status code 200 and file.

  • This API returns a response body with 'text/csv;charset=utf-8' or 'text/csv;charset=utf-16le' format when the request succeeded.

    And it returns a response body with 'application/json' format when the request has some errors.

# Report Fields by each ReportType
Name Description ACCOUNT CAMPAIGN AD_GROUP AD
Ad account name The name of the account
Ad account id The ID of the account
Campaign name The name of the campaign
Campaign Objective The type of campaign objective
Campaign id The ID of the campaign
Ad group name The name of the adGroup
Ad group id The ID of the adGroup
Ad name The name of the ad
Ad id The ID of the ad
Currency Currency of the account
Impressions The number of impressions
Clicks The number of clicks
CTR The number of CTR
CPC The number of CPC
Cost The number of costs
CV The number of conversions
CVR The number of CVR
CPA The number of CPA
Installs (clicks) The number of events of App install
(Click through conversion)
Installs (views) The number of events of App install
(View through conversion)
Installs (clicks and views) The number of events of App install
(Click + View through conversion)
Install rate (clicks) The ratio of events of App install to clicks
(Click through conversion)
Cost per Install (clicks) The costs per an event of App install
(Click through conversion)
Cost per Install (clicks and views) The costs per an event of App install
(Click + View through conversion)
Open The number of events of App opening
Open rate The ratio of events of App opening to clicks
Cost per Open The costs per an event of App opening
View home The number of events of the home views in the App
View home rate The ratio of events of the home views in the App to clicks
Cost per View home The costs per an event of the home view in the App
View category The number of events of the category views in the App
View category rate The ratio of events of the category views in the App to clicks
Cost per View category The costs per an event of the category view in the App
View item The number of events of the item views in the App
View item rate The ratio of events of the item views in the App to clicks
Cost per View item The costs per an event of the item view in the App
Search The number of events of search in the App
Search rate The ratio of the number of events of search in the App to clicks
Cost per Search The costs per an event of search in the App
Add to cart The number of events of adding to cart in the App
Add to cart rate The ratio of the number of events of adding to cart in the App to clicks
Cost per Add to cart The costs per an event of adding to cart in the App
Purchase The number of events of purchase in the App
Purchase rate The ratio of events of purchase in the App to clicks
Cost per Purchase The costs per an event of purchase in the App
Level achieved The number of events of achieved the level in the App
Level achieved rate The ratio of the number of events of achieved the level in the App to clicks
Cost per Level achieved The costs per an event of achieved the level in the App
Tutorial complete The number of events of completed the tutorial in the App
Tutorial complete rate The ratio of the number of events of completed the tutorial in the App to clicks
Cost per Tutorial complete The costs per an event of completed the tutorial in the App
< Custom conversion name > The number of events of custom conversion.
If the custom conversion name is 'CustomConversion', this column name is set to 'CustomConversion'.
This column is included in a report only while the conversion is accumulated.
< Custom conversion name > rate The number of CVR of custom conversion.
If the custom conversion name is 'CustomConversion', this column name is set to 'CustomConversion rate'.
This column is included in a report only while the conversion is accumulated.
Cost per < Custom conversion name > The number of CPA of custom conversion.
If the custom conversion name is 'CustomConversion', this column name is set to 'Cost per CustomConversion'. This column is included in a report only while the conversion is accumulated.
Video completions The number of completions watching a video
3-second video views The number of watching a video during 3 seconds
Video watches at 25% The number of watching a video by 25%.
Video watches at 50% The number of watching a video by 50%
Video watches at 75% The number of watching a video by 75%
Video watches at 95% The number of watching a video by 95%

# download/sample

Download sample reports.

  • This API can be used for downloading sample report data.

  • 4 types reports is available. Each report can be downloaded to specify the id assigned for each one.

    Report Type Id
    ACCOUNT 1
    CAMPAIGN 2
    AD_GROUP 3
    AD 4
# HTTP request

POST https://ads.line.me/api/v2.0/reports/download/sample

# Request headers

Content-Type

application/json

# Request body
Schema Required
ReportDownloadRequest Required
# Response

Returns status code 200 and file.

  • This API returns a response body with 'text/csv;charset=utf-8' format when the request succeeded.

    And it returns a response body with 'application/json' format when the request has some errors.

# OnlineReports

# get

Get online report jobs.

# HTTP request

POST https://ads.line.me/api/v2.0/reports/online/get

# Request headers

Content-Type

application/json

# Request body

accountId

String

Required

Id of the account

reportLevel

Enum (CAMPAIGN, ADGROUP, AD)

Required

The level of report to get

campaignId

Number

Optional

The campaign id to filter on the report

adgroupId

Number

Optional

The adgroup id to filter on the report

lpId

Number

Optional

The landing page id to filter on the report

name

String

Optional

The name to filter on the report

since

String

Optional

The date to receive after data from it.
Pattern : "YYYYMMDD"

until

String

Optional

The date to receive previous data from it.
Pattern : "YYYYMMDD"

removed

Boolean

Optional

The value whether including removed data or not in the result

pageNumber

Number

Optional

The page number of online report results. (Default 1)

pageSize

Number

Optional

The item size that can get by one api call. (Default 20)

# Response

Returns status code 200 and a JSON object with these properties:

accountId

String

Optional

Id of the account

operands

Array

Optional

List of OnlineReport as shown in the table below

operands[].account

Account

Optional

operands[].adgroup

AdGroup

Optional

operands[].ad

Ad

Optional

operands[].statistics

Object

Optional

OnlineReportStatistics as shown in the table below

operands[].statistics.currency

String

Optional

The currency of statistics

operands[].statistics.cost

Number

Optional

Cost

operands[].statistics.imp

Number

Optional

Impression

operands[].statistics.viewableImp

Number

Optional

Viewable impression

operands[].statistics.click

Number

Optional

Clicks

operands[].statistics.cv

Number

Optional

CV

operands[].statistics.videoCompletions

Number

Optional

Video 100% watched

operands[].statistics.videoView3s

Number

Optional

Video watched for at least 3 seconds (JP only)

operands[].statistics.videoView25r

Number

Optional

Video 25% watched (JP only)

operands[].statistics.videoView50r

Number

Optional

Video 50% watched (JP only)

operands[].statistics.videoView75r

Number

Optional

Video 75% watched (JP only)

operands[].statistics.videoView95r

Number

Optional

Video 95% watched (JP only)

operands[].statistics.reach

Number

Optional

Reach of reach & frequency

operands[].statistics.frequency

Number

Optional

Frequency of reach & frequency

operands[].statistics.ctr

Number

Optional

CTR

operands[].statistics.cvr

Number

Optional

CVR

operands[].statistics.cpc

Number

Optional

CPC

operands[].statistics.cpm

Number

Optional

CPM

operands[].statistics.cpa

Number

Optional

CPA

operands[].statistics.install

Number

Optional

Install count

operands[].statistics.vtInstall

Number

Optional

Install count(view) (JP only)

operands[].statistics.totalInstall

Number

Optional

Install count(click+view) (JP only)

operands[].statistics.open

Number

Optional

Open count

operands[].statistics.viewHome

Number

Optional

The number of viewing home

operands[].statistics.viewCategory

Number

Optional

The number of viewing category

operands[].statistics.viewItem

Number

Optional

The number of viewing item

operands[].statistics.search

Number

Optional

Search count

operands[].statistics.addToCart

Number

Optional

The number of adding cart

operands[].statistics.purchase

Number

Optional

Purchasing count

operands[].statistics.levelAchieved

Number

Optional

Level achieving count

operands[].statistics.tutorialComplete

Number

Optional

Tutorial completion count

operands[].statistics.installCtr

Number

Optional

Install CTR

operands[].statistics.installCpa

Number

Optional

Install CPA (click)

operands[].statistics.totalInstallCpa

Number

Optional

Install CPA (click+view) (JP only)

operands[].statistics.openCtr

Number

Optional

Open CTR

operands[].statistics.openCpa

Number

Optional

Open CPA

operands[].statistics.viewHomeCtr

Number

Optional

View home CTR

operands[].statistics.viewHomeCpa

Number

Optional

View home CPA

operands[].statistics.viewCategoryCtr

Number

Optional

View category CTR

operands[].statistics.viewCategoryCpa

Number

Optional

View category CPA

operands[].statistics.viewItemCtr

Number

Optional

View item CTR

operands[].statistics.viewItemCpa

Number

Optional

View item CPA

operands[].statistics.searchCtr

Number

Optional

Search CTR

operands[].statistics.searchCpa

Number

Optional

Search CPA

operands[].statistics.addToCartCtr

Number

Optional

Add-to-cart CTR

operands[].statistics.addToCartCpa

Number

Optional

Add-to-cart CPA

operands[].statistics.purchaseCtr

Number

Optional

Purchase CTR

operands[].statistics.purchaseCpa

Number

Optional

Purchase CPA

operands[].statistics.levelAchievedCpa

Number

Optional

Level achieved CTR

operands[].statistics.levelAchievedCtr

Number

Optional

Level achieved CPA

operands[].statistics.tutorialCompleteCtr

Number

Optional

Tutorial complete CTR

operands[].statistics.tutorialCompleteCpa

Number

Optional

Tutorial complete CPA

# CustomAudiences

# get

Get CustomAudiences.

# HTTP request

POST https://ads.line.me/api/v2.0/custom_audiences/get

# Request headers

Content-Type

application/json

# Request body

sortType

Enum (ASC, DESC)

Optional

The order to sort the result

page

Number

Optional

The number of page

results

Number

Optional

The number of results to return.
Minimum value : 1
Maximum value : 500

accountId

String

Required

Id of the account

sortKey

Enum (ID, NAME, TYPE, STATUS)

Optional

The key to sort the result

# Response

Returns status code 200 and a JSON object with these properties:

accountId

String

Required

Id of the account

operands

Array

Required

List of CustomAudience as shown in the table below.
Size: 1 - 100

operands[].id

Number

Optional

Id of this custom audience

operands[].type

Enum (WEB_TRAFFIC, UPLOAD, LOOKALIKE, MOBILE_APP, ACCOUNT_FRIEND)

Optional

The type of custom audience

operands[].name

String

Optional

The name of this custom audience

operands[].status

Enum (IN_PROGRESS, READY, FAILED, EXPIRED)

Optional
read-only

The status of custom audience creation

operands[].errorReason

String

Optional
read-only

Error Reason that custom audience cannot be created

operands[].webTraffic

Object

Optional

WebTraffic as shown in the table below

operands[].webTraffic.type

Enum (VISIT_ALL, URL_MATCHING, EVENT_MATCHING)

Required

Target type for accumulating visiting history

operands[].webTraffic.recency

Number

Required

The valid period of visiting history to the website.
Minimum value : 1
Maximum value : 180

operands[].webTraffic.eventRule

Object

Optional

EventRule as shown in the table below

operands[].webTraffic.eventRule.eventType

Enum (CONVERSION_EVENT, CUSTOM_EVENT)

Required

Target event of visiting history for accumulating one

operands[].webTraffic.eventRule.customEventName

String

Optional

The name of custom event

operands[].webTraffic.urlRules

Array of UrlRule

Optional

operands[].lookalike

Object

Optional

Lookalike as shown in the table below. The URL rule for accumulating visit history.

operands[].lookalike.ratio

Number (float)

Optional

This parameter will be deprecated. The ratio of audience size to users using LINE in Japan.

operands[].lookalike.volumnRate

String

Optional

The ratio of audience size to users using LINE in Japan in string. Normally number with string type.

operands[].lookalike.sourceCustomAudienceId

Number

Required

Id of source audience for selecting similar users

operands[].mobileApp

Object

Optional

MobileApp as shown in the table below

operands[].mobileApp.mediaAppId

Number

Required

The id of target media app

operands[].mobileApp.appEventType

Enum (INSTALL, OPEN, ADD_TO_CART, PURCHASE, VIEW_HOME, VIEW_CATEGORY, VIEW_ITEM, SEARCH, LEVEL_ACHIEVED, TUTORIAL_COMPLETE, CUSTOM)

Required

Target event type for accumulating it

operands[].mobileApp.recency

Number

Required

The valid period of occurred app event.
Minimum value : 1
Maximum value : 180

operands[].mobileApp.matchingRules

Array

Optional

AppEventRule. The rule for accumulating app events

operands[].mobileApp.matchingRules.parameter

Enum (CATEGORY_IDS, ITEM_IDS, ITEM_PRICE, ITEM_QUANTITY, SEARCH_KEYWORDS, LEVEL_IDS, DATA, EVENT_NAMES)

Required

The column of an app event detail

operands[].mobileApp.matchingRules.values

Array of string

Optional

The value of an app event detail

operands[].mobileApp.matchingRules.matchType

Enum (EQUALS, NOT_EQUAL, CONTAIN, NOT_CONTAIN, STARTS_WITH, ENDS_WITH, GREATER_THAN, LESS_THAN, GREATER_THAN_EQUALS, LESS_THAN_EQUALS)

Required

The match type of this rule

operands[].accountFriends

Object

Optional

AccountFriends as shown in the table below

operands[].accountFriends.targetFriendType

Enum (ACTIVE, BLOCKED)

Required

Target friend type of the account friends audience

operands[].errors

Array of Error

Optional
read-only

This field exists when errors occurred only.

# CustomConversions

# get

Get CustomConversions.

# HTTP request

POST https://ads.line.me/api/v2.0/custom_conversions/get

# Request body

sortType

Enum (ASC, DESC)

Optional

The order to sort the result

page

Number

Optional

The number of page

results

Number

Optional

The number of results to return.
Minimum value : 1
Maximum value : 500

accountId

String

Required

Id of the account

sortKey

Enum (ID, NAME, LAST_CONTACT_DATE, USER_STATUS)

Optional

The key to sort the result

# Response

Returns status code 200 and a JSON object with these properties:

accountId

String

Required

Id of the account

operands

Array

Required

List of CustomConversion as shown in the table below

operands[].id

Number

Optional

Id of this custom conversion

operands[].name

String

Optional

The name of this custom conversion

operands[].description

String

Optional

The description of this custom conversion

operands[].userStatus

Enum (ACTIVE, PAUSED)

Optional

The status of custom conversion.
This field is ignored when action is 'add'.

operands[].attributionPeriod

Number

Optional

The term of tracking conversion.

operands[].matchingMethod

Enum (URL_MATCHING, EVENT_MATCHING)

Optional

The method of applying conditions to accumulating conversions

operands[].eventRule

Object

Optional

ConversionEventRule as shown in the table below

operands[].eventRule.eventType

Enum (CONVERSION_EVENT, CUSTOM_CONVERSION_EVENT)

Required

Target conversion event for accumulating one

operands[].eventRule.customEventName

String

Optional

The name of custom event

operands[].urlRules

UrlRule

Optional

operands[].errors

Array of Error

Optional
read-only

This field exists when errors occurred only.

# Areas

# get

Get master data of area.

# HTTP request

POST https://ads.line.me/api/v2.0/areas/get

# Request headers

Content-Type

application/json

# Request body

country

Enum (JP, TH, TW)

Optional

The target area’s country

# Response

Returns status code 200 and array of Area JSON object.

# Definitions

# Campaigns

This is a JSON object with the following properties.

accountId

String

Required

Id of the account

operands

Array

Required

List of Campaign as shown in the table below.
Size: 1 - 100

operands[].id

Number

Optional

Id of this campaign

operands[].name

String

Optional

Name of this campaign.
Length : 1 - 120

operands[].campaignObjectiveType

Enum (VISIT_MY_WEBSITE, APP_INSTALL, APP_ENGAGEMENT, WEBSITE_CONVERSION, DYNAMIC_PRODUCT, GAIN_FRIENDS)

Optional

The objective of this campaign.
This field will be ignored when the action is set.

operands[].userStatus

Enum (ACTIVE, PAUSED, REMOVED)

Optional

The status of this campaign.
If the entity is removed, this status becomes “REMOVED”.

operands[].deliveryStatus

Enum (ACTIVE, PAUSED, REMOVED, NOT_DELIVERING, NOT_APPROVED)

Optional
read-only

The status of delivery ad

operands[].deliveryStatusReasons

Array of enum (AD_PAUSED, ADGROUP_PAUSED, CAMPAIGN_PAUSED, ACCOUNT_PAUSED, REMOVED, AD_NOT_APPROVED, AD_BLOCKED, CREATIVE_BLOCKED, AD_IN_REVIEW, APP_NOT_APPROVED, ADGROUP_BLOCKED, APP_IN_REVIEW, CAMPAIGN_BLOCKED, CAMPAIGN_SCHEDULED, CAMPAIGN_ENDED, CAMPAIGN_SPENDING_LIMIT_OVER, CAMPAIGN_CPF_NOT_VERIFIED, NO_PRODUCT_FEED, PRODUCT_FEED_IN_REVIEW, PRODUCT_FEED_REJECTED, BILLING_NOT_APPROVED, BILLING_IN_REVIEW, BILLING_NOT_LINKED, ACCOUNT_NOT_APPROVED, ACCOUNT_BLOCKED, ACCOUNT_IN_REVIEW, ACTIVE_ADGROUP_LEARNING, ACCOUNT_SPENDING_LIMIT_OVER, LINE_ACCOUNT_NOT_EXIST, LINE_ACCOUNT_STATUS_DELETED, LINE_ACCOUNT_STATUS_IN_ACTIVE, LINE_ACCOUNT_LINK_NOT_APPROVED)

Optional
read-only

The reason of delivery status

operands[].spendingLimit

SpendingLimit

Optional

operands[].startDate

String

Optional

The date of starting to delivery ads (in local date for the account).
Pattern : "YYYYMMDD HH:mm:ss"

operands[].endDate

String

Optional

The date of suspending delivering ads (in local date for the account).
Set the word 'NONE' to this field if you want to erase endDate.
Pattern : "YYYYMMDD HH:mm:ss"

operands[].createdDate

String

Optional
read-only

The date of campaign created
Pattern : "YYYYMMDD HH:mm:ss"

operands[].updatedDate

String

Optional
read-only

The date of campaign modified
Pattern : "YYYYMMDD HH:mm:ss"

operands[].errors

Array of Error

Optional
read-only

This field exists when errors occurred only.

# AdGroups

accountId

String

Required

Id of the account.

operands

Array of AdGroup

Required

List of AdGroup.
Size: 1 - 100

# Area

code

String

Required

The code of the area.
The code can be referred on the Areas API.

name

String

Optional
read-only

The name of the area

children

Array of Area

Optional
read-only

The list of child areas.
The children is optional.

# Ads

accountId

String

Required

Id of the account

operands

Array of Ad

Required

List of Ad.
Size: 1 - 100

# Media

id

Number

Optional

Id of this media

name

String

Optional

The name of this media

mediaType

Enum (IMAGE, VIDEO, APP)

Optional

The type of this media

mimeType

String

Optional
read-only

The type of content of this media

width

Number

Optional
read-only

Horizontal length of this media

height

Number

Optional
read-only

Vertical length of this media

fileSize

Number

Optional
read-only

File size of this media

mediaHash

String

Optional
read-only

Hash code of this media

sourceUrl

String

Optional
read-only

The url of this media

duration

Number

Optional
read-only

Duration time of video

osName

Enum (IOS, ANDROID)

Optional

The name of mobile operating system

appStoreUrl

String

Optional

The url of the page for that app on store

appId

String

Optional

The identifier of this App.
This field can be set 'App ID' for iOS or 'Package Name' for Android.

reviewStatus

Enum (SKIPPED_REVIEW, IN_REVIEW, APPROVED, REJECTED)

Optional
read-only

Review status of this creative

createdDate

String

Optional
read-only

Created date of media
Pattern : "YYYYMMDD HH:mm:ss"

updatedDate

String

Optional
read-only

Last updated date of media
Pattern : "YYYYMMDD HH:mm:ss"

removedDate

String

Optional
read-only

Removed date of media
Pattern : "YYYYMMDD HH:mm:ss"

errors

Array of Error

Optional
read-only

This field exists when errors occurred only.

# Reports

accountId

String

Required

Id of the account

operands

Array

Required

List of Report as shown in the table below.
Size: 1 - 100

operands[].id

Number

Optional

Id of this report

operands[].name

String

Optional
read-only

Name of this report

operands[].status

Enum (CREATED, PREPARING, ERROR, READY)

Optional
read-only

The status of report creation

operands[].startDate

String

Optional

The start date to display statistics.
Pattern : "YYYYMMDD"

operands[].endDate

String

Optional

The end date to display statistics.
Pattern : "YYYYMMDD"

operands[].reportType

Enum (ACCOUNT, CAMPAIGN, AD_GROUP, AD)

Optional

The type of report

operands[].breakdown

Breakdown

Optional

operands[].createdDate

String

Optional

The date of registered this report

operands[].errors

Array of Error

Optional
read-only

This field exists when errors occurred only.

# ReportDownloadRequest

accountId

String

Required

Id of the account

id

Number

Required

Id of this report

# AuthorityDelegations

This is a JSON object with the following properties.

operands

Array

Required

List of AuthorityDelegation as shown in the table below.
Size: 1 - 100

operands[].id

Number

Optional

Id of this authority delegation

operands[].sourceGroupId

String

Optional
read-only

Id of the group which is requesting for delegating authority.
Default value is your root group id.

operands[].accountId

String

Optional

Id of the account to be requested delegating authority

operands[].approvalStatus

Enum (WAITING_APPROVAL, REJECTED, LINKED, CANCELED, UNLINKED, REVOKED)

Optional
read-only

The status of approval by account requested to delegate authority

operands[].requestedDateUtc

String

Optional
read-only

The date of requested delegate authority (in UTC)

operands[].approvedDateUtc

String

Optional
read-only

The date that the account approved this request (in UTC)

operands[].errors

Array of Error

Optional
read-only

This field exists when errors occurred only.

# Error

reason

String

Optional
read-only

The reason of the error

property

String

Optional
read-only

The property which caused the error

# SpendingLimit

type

Enum (NONE, MONTHLY, LIFETIME)

Required

The type of spending limit

microAmount

Number

Optional

The limit of spending amount in micros (in the local currency for the account)

# AdGroup

id

Number

Optional

Id of this adGroup

campaignId

Number

Optional

Id of campaign as parent of adGroup

mediaAppId

Number

Optional

Id of media app which you advertise

mediaApp

Media

Optional
read-only

name

String

Optional

Name of this adGroup.
Length : 1 - 120

userStatus

Enum (ACTIVE, PAUSED, REMOVED)

Optional

The status of this adGroup.
If the entity is removed, this status becomes “REMOVED”.

deliveryStatus

Enum (ACTIVE, PAUSED, REMOVED, NOT_DELIVERING, NOT_APPROVED)

Optional
read-only

The status of delivery ad

deliveryStatusReasons

Array of enum (AD_PAUSED, ADGROUP_PAUSED, CAMPAIGN_PAUSED, ACCOUNT_PAUSED, REMOVED, AD_NOT_APPROVED, AD_BLOCKED, CREATIVE_BLOCKED, AD_IN_REVIEW, APP_NOT_APPROVED, ADGROUP_BLOCKED, APP_IN_REVIEW, CAMPAIGN_BLOCKED, CAMPAIGN_SCHEDULED, CAMPAIGN_ENDED, CAMPAIGN_SPENDING_LIMIT_OVER, CAMPAIGN_CPF_NOT_VERIFIED, NO_PRODUCT_FEED, PRODUCT_FEED_IN_REVIEW, PRODUCT_FEED_REJECTED, BILLING_NOT_APPROVED, BILLING_IN_REVIEW, BILLING_NOT_LINKED, ACCOUNT_NOT_APPROVED, ACCOUNT_BLOCKED, ACCOUNT_IN_REVIEW, ACTIVE_ADGROUP_LEARNING, ACCOUNT_SPENDING_LIMIT_OVER, LINE_ACCOUNT_NOT_EXIST, LINE_ACCOUNT_STATUS_DELETED, LINE_ACCOUNT_STATUS_IN_ACTIVE, LINE_ACCOUNT_LINK_NOT_APPROVED, ALL_AUDIENCE_NOT_ACTIVE, EXCLUDE_SHARED_AUDIENCE_NOT_ACTIVE)

Optional
read-only

The reason of delivery status

adGroupLearning

AdGroupLearning

Optional
read-only

bid

Bid

Optional

dailyBudgetMicro

Number

Optional

Daily budget in micros (in the local currency for the account)

autoBidType

Enum (MANUAL, MAXIMIZE_CLICKS, MAXIMIZE_CONVERSIONS, MAXIMIZE_INSTALLS, MAXIMIZE_FRIEND)

Optional

The type of auto bidding

targeting

Targeting

Optional

dpaDestinationType

dpaDestinationUrl

String

Optional

The url of DPA destination (DPA only)

rnfStartDate

String

Optional

Reach & Frequency’s start date.
Pattern : "YYYYMMDD HH:mm:ss"

rnfEndDate

String

Optional

Reach & Frequency’s end date.
Pattern : "YYYYMMDD HH:mm:ss"

rnfFrequency

Number

Optional

Reach & Frequency’s frequency cap.
Minimum value : 2
Maximum value : 10

createdDate

String

Optional
read-only

The date of campaign created
Pattern : "YYYYMMDD HH:mm:ss"

updatedDate

String

Optional
read-only

The date of campaign modified
Pattern : "YYYYMMDD HH:mm:ss"

errors

Array of Error

Optional
read-only

This field exists when errors occurred only.

# AdGroupLearning

learningStatus

Enum (LEARNING, NONE)

Optional

The status of learning

learningStatusCode

Number

Optional

The code of learning

lastLearningStartTs

Number

Optional

The start date of learning
ex.) 1569900000

lastLearningEndTs

Number

Optional

The end date of learning
ex.) 1569900000

targetReachRatio

Number

Optional

The percentage of progress
ex.) 0.3

hasLearningCompletionHistory

Boolean

Optional

Whether learning has been completed in the past

# Bid

type

Enum (CPC, CPM, CPF)

Optional

The type of bidding.
This field will be ignored when the action is set.

microAmount

Number

Optional

Bid amount in micros (in the local currency for the account).
This field is used as bidAmount, maxCpc, maxCpa, etc depending on the autoBidType.

strategy

Enum (SET_MAX, LOWEST_COST, COST_CAP)

Optional

The strategy of auto bidding.
This field must be filled when using autoBidType.
When using lowest cost option, microAmount must be null.
SET_MAX - Set a bid amount cap
LOWEST_COST - No limit; expend daily budget as aggressively as possible
COST_CAP - Set a target event cost cap

# Targeting

Each targeting parameter is replaced with each one in a request when you call 'set' action.

osVersions

Array

Optional

List of OsVersion as shown in the table below

osVersions[].osName

Enum (IOS, ANDROID)

Required

The name of mobile operating system

osVersions[].minVersion

String

Optional

The minimum version in a range of the operating system version
ex.) 10.0

osVersions[].maxVersion

String

Optional

The maximum version in a range of the operating system version
ex.) 10.1

customAudiences

Array of number

Optional

List of audience Id for bidding

excludedCustomAudiences

Array of number

Optional

List of audience Id for excluding

areas

Array of Area

Optional

List of Area

interests

Array

Optional

List of Interest

interests[].code

String

Required

The code number of interest as shown in the table below.
1 - Game
2 - Digital Gadget
3 - Sports
4 - Careers & Business
5 - Fashion
6 - Home & Garden
7 - Television & Movie
8 - Music
9 - Education
10 - Finance Services
11 - Health & Fitness
12 - Automotive
12.8 - Automotive : Kei car (660 cc) (JP only)
12.9 - Automotive : Compact car (JP only)
12.10 - Automotive : Hatchback (JP only)
12.11 - Automotive : Sedan (JP only)
12.12 - Automotive : Sports car (JP only)
12.13 - Automotive : Station wagon (JP only)
12.14 - Automotive : Minivan (JP only)
12.15 - Automotive : SUV (compact) (JP only)
12.16 - Automotive : SUV (large) (JP only)
15 - Book & Comic
16 - Food & Drink
17 - Beauty
18 - Travel
30 - Entertainment
31 - Shopping

interests[].name

String

Optional
read-only

The name of interest

genders

Array of enum (MALE, FEMALE)

Optional

List of gender code

ageMin

Enum (UNLIMITED, AGE_15, AGE_20, AGE_25, AGE_30, AGE_35, AGE_40, AGE_45, AGE_50)

Optional

The minimum age in a range of age targeting

ageMax

Enum (AGE_14, AGE_19, AGE_24, AGE_29, AGE_34, AGE_39, AGE_44, AGE_49, UNLIMITED)

Optional

The maximum age in a range of age targeting

placementTypes

Array

Optional

List of placement network type (PlacementType) as shown in the table below

placementTypes[].Type

enum (LINE, LFP_DISPLAY, LFP_REWARD)

The name of placement network.
LADN will be deprecated, and LFP_DISPLAY will replace this code.

marital

Enum (MARRIED, UNMARRIED)

Optional

The status of marriage (JP only)

child

Enum (HAVE, NONE)

Optional

The existence of child (JP only)

tvAudiences

Array

Optional

List of tv audience type (TvAudienceType) as shown in the table below (JP only)

tvAudiences[].Type

enum (HIGH, MIDDLE, LOW)

The type of tv audience (JP only)

carriers

Array

Optional

List of phone carrier type (CarrierType) as shown in the table below (JP only)

carriers[].Type

enum (DOCOMO, AU, SOFTBANK)

The type of phone carrier (JP only)

# DpaDestinationType

Type

Enum (APP_STORE_URL, WEB_URL, TRACKING_URL_CMS)

The type of DPA destination (DPA only)

id

Numbe

Optional

Id of this ad

adGroupId

Number

Optional

Id of adGroup as parent of Ad

creative

Creative

Optional

name

String

Optional

Name of this ad.
Length : 1 - 120

userStatus

Enum (ACTIVE, PAUSED, REMOVED)

Optional

The status of this ad.
If the entity is removed, this status becomes “REMOVED”.

createdDate

String

Optional
read-only

Created date of ad.
Pattern : "YYYYMMDD HH:mm:ss"

updatedDate

String

Optional
read-only

Last updated date of ad.
Pattern : "YYYYMMDD HH:mm:ss"

deliveryStatus

Enum (ACTIVE, PAUSED, REMOVED, NOT_DELIVERING, NOT_APPROVED)

Optional
read-only

The status of delivery ad

deliveryStatusReasons

Array of enum (AD_PAUSED, ADGROUP_PAUSED, CAMPAIGN_PAUSED, ACCOUNT_PAUSED, REMOVED, AD_NOT_APPROVED, AD_BLOCKED, CREATIVE_BLOCKED, AD_IN_REVIEW, APP_NOT_APPROVED, ADGROUP_BLOCKED, APP_IN_REVIEW, CAMPAIGN_BLOCKED, CAMPAIGN_SCHEDULED, CAMPAIGN_ENDED, CAMPAIGN_SPENDING_LIMIT_OVER, CAMPAIGN_CPF_NOT_VERIFIED, NO_PRODUCT_FEED, PRODUCT_FEED_IN_REVIEW, PRODUCT_FEED_REJECTED, BILLING_NOT_APPROVED, BILLING_IN_REVIEW, BILLING_NOT_LINKED, ACCOUNT_NOT_APPROVED, ACCOUNT_BLOCKED, ACCOUNT_IN_REVIEW, ACTIVE_ADGROUP_LEARNING, ACCOUNT_SPENDING_LIMIT_OVER, LINE_ACCOUNT_NOT_EXIST, LINE_ACCOUNT_STATUS_DELETED, LINE_ACCOUNT_STATUS_IN_ACTIVE, LINE_ACCOUNT_LINK_NOT_APPROVED, ALL_AUDIENCE_NOT_ACTIVE, EXCLUDE_SHARED_AUDIENCE_NOT_ACTIVE)

Optional
read-only

The reason of delivery status

errors

Array of Error

Optional
read-only

This field exists when errors occurred only.

# Creative

id

Number

Optional

Id of this creative

creativeFormat

Enum (IMAGE, VIDEO, CAROUSEL)

Required

Type of creative format

title

String

Required

The title of this creative.
This property is required if 'creativeFormat' is IMAGE or VIDEO.

description

String

Required

The description of this creative.
This property is required if 'creativeFormat' is IMAGE or VIDEO.

mediaHash

String

Required

Hash code of media which is registered with Media API.
This property is required if 'creativeFormat' is IMAGE or VIDEO.

callToActionType

Enum (LISTEN_NOW, WATCH_MORE, DOWNLOAD, LEARN_MORE, INSTALL_NOW, WATCH_VIDEO, PLAY_GAME, SIGN_UP, USE_APP, SHOP_NOW, CONTACT_US, BOOK_NOW, ADD_FRIEND)

Required

The label of action button.
This property is required if 'creativeFormat' is IMAGE or VIDEO.

finalUrl

String

Optional

This parameter is deprecated. It will be removed in near future. Use 'landingPageUrl' instead.

landingPageUrl

String

Optional

The url of the page users will be sent to after clicking that ad.

clickUrl

String

Optional

The url for measuring performance of ad and tracking attributes.
If the viewTrackUrl is given, it is mandatory and must start with 'https://app.adjust.com'

appStoreUrl

String

Optional

The url of the page for that app on store

deepLinkUrl

String

Optional

The link to an installed app on user’s mobile device

viewTrackUrl

String

Optional

The url for measuring view through conversion of ad. It is shown as 'Impression URL' at the management site. Currently, It should be started with 'https://view.adjust.com'. It can be used when

  • adaccount’s country is JP
  • bid type is CPM
  • campaign objective is APP_INSTALL
  • creative format is VIDEO

slots

Array of CreativeSlot

Optional

Slots of carousel type creative.
When 'creativeFormat' is CAROUSEL, it is required and creative properties(title, descriotion...) should be set by slots.
Size: 2 - 10

reviewStatus

Enum (SKIPPED_REVIEW, IN_REVIEW, APPROVED, REJECTED)

Optional
read-only

Review status of this creative

# CreativeSlot

title

String

Required

The title of this creative slot.

description

String

Required

The description of this creative slot.

mediaHash

String

Required

Hash code of media which is registered with Media API.

callToActionType

Enum (LISTEN_NOW, WATCH_MORE, DOWNLOAD, LEARN_MORE, INSTALL_NOW, WATCH_VIDEO, PLAY_GAME, SIGN_UP, USE_APP, SHOP_NOW, CONTACT_US, BOOK_NOW, ADD_FRIEND)

Required

The label of action button.

finalUrl

String

Optional

This parameter is deprecated. It will be removed in near future. Use 'landingPageUrl' instead.

landingPageUrl

String

Optional

The url of the page users will be sent to after clicking that ad.

clickUrl

String

Optional

The url for measuring performance of ad and tracking attributes.
If the viewTrackUrl is given, it is mandatory and must start with 'https://app.adjust.com'

appStoreUrl

String

Optional

The url of the page for that app on store.

deepLinkUrl

String

Optional

The link to an installed app on user’s mobile device.

# Breakdown

deliveryType

Enum (OS, GENDER, AGE, INTEREST)

Optional

The unit of delivery segment for collecting report

timeUnit

Enum (DAY)

Optional

Time unit for collecting report

bySsp

Boolean

Optional

The flag that separating report by ssp type

# UrlRule

The URL rule for accumulating visit history.

keywords

Array of string

Required

Target keywords for accumulating visit history

matchType

Enum (EQUALS, CONTAIN, NOT_CONTAIN)

Required

The match type of URL rule

# Group

id

String

Optional

The id of this group.

name

String

Optional

The name of this group.

parentGroupId

String

Optional
read-only

The id of parent group.

parentGroupName

String

Optional
read-only

The name of parent group.

depth

Number

Optional
read-only

The number of ancestor groups.

createdDate

String

Optional
read-only

Created date of this group.
Date timezone is Asia/Tokyo(UTC+9).
Pattern : "YYYYMMDD HH:mm:ss"

updatedDate

String

Optional
read-only

Last updated date of this group.
Date timezone is Asia/Tokyo(UTC+9).
Pattern : "YYYYMMDD HH:mm:ss"

errors

Array of Error

Optional
read-only

This field exists when errors occurred only.

# Account

id

Number

Optional
read-only

Id of this account

name

String

Optional
read-only

The name of this account

userStatus

Enum (ACTIVE, PAUSED, REMOVED)

Optional
read-only

The status of this account

deliveryStatus

Enum (ACTIVE, PAUSED, REMOVED, NOT_DELIVERING, NOT_APPROVED)

Optional
read-only

The status of delivery ad

deliveryStatusReasons

Array of enum (AD_PAUSED, ADGROUP_PAUSED, CAMPAIGN_PAUSED, ACCOUNT_PAUSED, REMOVED, AD_NOT_APPROVED, AD_BLOCKED, CREATIVE_BLOCKED, AD_IN_REVIEW, APP_NOT_APPROVED, ADGROUP_BLOCKED, APP_IN_REVIEW, CAMPAIGN_BLOCKED, CAMPAIGN_SCHEDULED, CAMPAIGN_ENDED, CAMPAIGN_SPENDING_LIMIT_OVER, CAMPAIGN_CPF_NOT_VERIFIED, NO_PRODUCT_FEED, PRODUCT_FEED_IN_REVIEW, PRODUCT_FEED_REJECTED, BILLING_NOT_APPROVED, BILLING_IN_REVIEW, BILLING_NOT_LINKED, ACCOUNT_NOT_APPROVED, ACCOUNT_BLOCKED, ACCOUNT_IN_REVIEW, ACTIVE_ADGROUP_LEARNING, ACCOUNT_SPENDING_LIMIT_OVER, LINE_ACCOUNT_NOT_EXIST, LINE_ACCOUNT_STATUS_DELETED, LINE_ACCOUNT_STATUS_IN_ACTIVE, LINE_ACCOUNT_LINK_NOT_APPROVED)

Optional
read-only

The reason of delivery status.

availableCampaignObjectiveTypes

Array of enum (VISIT_MY_WEBSITE, APP_INSTALL, APP_ENGAGEMENT, WEBSITE_CONVERSION, DYNAMIC_PRODUCT, GAIN_FRIENDS, REACH_AND_FREQUENCY)

Optional

autoBiddingInstall

Boolean

Optional

Auto bidding enable status for install ad

currency

String

Optional
read-only

The currency of this account

timezone

String

Optional
read-only

The timezone of this account

country

String

Optional
read-only

The country of this account

lineAccount

Object

Optional

LineAccount as shown in the table below

lineAccount.name

String

Optional
read-only

The name of LINE account

lineAccount.lineId

String

Optional

The ID of LINE account

# Error Codes

# Error Code Descriptions

Code Description
ACCESSIBLE_ACCOUNT_LIMIT_EXCEEDED The number of account link exceeds limit.
ACCOUNT_ALREADY_EXIST_IN_GROUP_TREE Account already exists in group tree.
ACCOUNT_FRIEND_WITH_SAME_PARAMETERS_ALREADY_EXISTS Same friend audience already exists.
ACCOUNT_LINKED_TOO_MANY_GROUPS The number of account-group link exceeds limit.
ACTIVE_AD_IN_ADGROUP_COUNT_LIMIT_EXCEEDED The number of active ad in adgroup exceeds limit.
ADGROUP_APP_INSTALL_EVENT_NOT_YET App install event is not captured yet.
ADGROUP_COUNT_LIMIT_EXCEEDED The number of adgroup count exceeds limit.
ADGROUP_IN_CAMPAIGN_COUNT_LIMIT_EXCEEDED The number of adgroup in campaign exceeds limit.
ADGROUP_NAME_DUPLICATED Adgroup name is duplicated.
ADGROUP_REQUIRE_ALL_RNF_FIELDS All R&F fields in the adgroup is required.
ADGROUP_RNF_FIELDS_NOT_ALLOWED R&F field in the adgroup is not allowed.
ADGROUP_RNF_OUR_OF_DURATION_RANGE R&F is out of range.
ADGROUP_RNF_PERIOD_IS_NOT_IN_CAMPAIGN_PERIOD R&F period is not in campaign period.
ADGROUP_UPDATING_RNF_BID_AMOUNT_NOT_ALLOWED Updating bidAmount in R&F campaign is not allowed.
ADGROUP_UPDATING_RNF_DURATION_SHOULD_INCREASE Updating R&F duration is only allowed in increasing manner.
ADGROUP_UPDATING_RNF_FREQUENCY_SHOULD_INCREASE Updating R&F frequency is only allowed in increasing manner.
ADGROUP_UPDATING_RNF_START_DATE_NOT_ALLOWED Updating R&F startDate is not allowed.
AD_CLICK_URL_IS_MANDATORY_WITH_VIEW_TRACK_URL Click URL is mandatory when view track URL is given.
AD_CLICK_URL_MUST_MATCHED_VIEW_TRACK _DOMAIN The domain of click URL must be matched with view track URL.
AD_COUNT_LIMIT_EXCEEDED The number of ad in account exceeds limit.
AD_INVALID_FORMAT Creative’s format is invalid.
AD_INVALID_FORMAT_VIEW_TRACK_URL Creative’s format is invalid with view track URL.
AD_INVALID_VIEW_TRACK_DOMAIN View track URL’s domain must be started with https://view.adjust.com.
AD_IN_ADGROUP_COUNT_LIMIT_EXCEEDED The number of ad in adgroup exceeds limit.
AD_NAME_DUPLICATED Ad name is duplicated.
AD_URL_NOT_FIT_CAMPAIGN_OBJECTIVE Ad url is not fit with campaign objective.
AD_VIEW_TRACK_BIDTYPE_MUST_CPM Bid type of adgroup must be CPM when view track URL has entered.
AD_VIEW_TRACK_URL_SUPPORT_APP_INSTALL View track URL is supported for APP_INSTALL campaign objective.
AD_VIEW_TRACK_URL_SUPPORT_JP View track URL is supported for JP adaccount only.
AGE_MIN_MAX_REVERSED Min age is bigger than max age.
APP_COUNT_LIMIT_EXCEEDED The number of app in account exceeds limit.
APP_EVENT_TYPE_CANNOT_BE_USED App event type cannot be used.
AUTHORIZATION_FAILED Authorization failed.
AUTO_BID_NOT_ALLOWED The campaign objective is not allowed auto bid type.
BID_TYPE_NOT_ALLOWED The campaign objective is not allowed the bid type.
CAMPAIGN_COUNT_LIMIT_EXCEEDED The number of campaign count exceeds limit.
CAMPAIGN_NAME_DUPLICATED Campaign name is duplicated.
CANNOT_CREATE_DPA_CAMPAIGN_AD Cannot create DPA campaign ad.
CANNOT_DELETE_DPA_CAMPAIGN_AD Cannot delete DPA campaign ad.
CANNOT_DELETE_ENTITY Entity cannot be deleted.
CANNOT_DOWNLOAD_REPORT Cannot download report.
CANNOT_EDIT_ENTITY Entity cannot be edited.
CANNOT_REMOVE_AUDIENCE_STILL_IN_USE The audience that you want to remove is in using state.
CANNOT_REMOVE_AUDIENCE_STILL_IN_USE_AS_LOOKALIKE_SOURCE The audience that you want to remove is in using state.
CANNOT_SET_DATE_TO_FUTURE Date must not be future.
CANNOT_SET_DATE_TO_PAST Date must not be past.
CANNOT_SET_FIELD Field cannot be set.
CANNOT_SET_MEDIA_APP Media app doesn’t be needed given campaign objective.
CANNOT_SPECIFY_DELIVERY_TYPE_ON_AD_REPORT Cannot specify delivery type.
CANNOT_TARGET_AND_EXCLUDE_SAME_AUDIENCE Included audiences and excluded audiences are conflict.
CAROUSEL_CAMPAIGN_OBJECTIVE_NOT_AVAILABLE The carousel format is only available for campaign.
CAROUSEL_ONLY_USE_1_1_IMAGE Carousel ad can only use 1:1 image.
CAROUSEL_SLOT_SIZE_OUT_OF_RANGE Carousel ad slot size should be between 2 to 10.
CUSTOM_AUDIENCE_COUNT_LIMIT_EXCEEDED The number of audience in group exceeds limit.
CUSTOM_AUDIENCE_NAME_DUPLICATED Custom audience name is duplicated.
CUSTOM_CONVERSION_NAME_DUPLICATED Custom conversion name is duplicated.
DPA_CAMPAIGN_COUNT_LIMIT_EXCEEDED The number of dpa campaign count exceeds limit.
DUPLICATE_KEY Field has duplicated key.
DURATION_LIMIT_EXCEEDED Duration exceeds limit.
DURATION_TOO_SHORT Duration is too short.
EMPTY_FILE File is empty.
ENTITY_LIMIT_EXCEEDED The number of audience group exceeds limit.
EVENT_NAME_NOT_EXISTS Event name does not exist.
FILE_SIZE_LIMIT_EXCEEDED File exceeds limit size.
GAIN_FRIENDS_MUST_EXCLUDE_ACCOUNT_FRIEND_AUDIENCE Not found excluded account friend audience in gain friends campaign.
GROUP_ALREADY_HAS_SAME_ACCOUNT_LINK Group already has same account link.
GROUP_ALREADY_REQUESTED_SAME_ACCOUNT Group already requested same account.
ILLEGAL_ARGUMENT There is illegal argument.
IMAGE_COUNT_LIMIT_EXCEEDED The number of image in account exceeds limit.
INVALID_ACCOUNT_ID Invalid account id
INVALID_ADVERTISING_ID Advertising id format is invalid.
INVALID_ASPECT_RATIO Invalid aspect ratio
INVALID_COMBINATION_EVENT_TYPE_AND_PARAMETER Invalid conbination of event type and parameter
INVALID_COMBINATION_PARAMETER_AND_MATCH_TYPE Invalid combination of parameter and condition
INVALID_CUSTOM_AUDIENCE Invalid audience exists
INVALID_DATE_FORMAT Field has invalid date format.
INVALID_ENUM Field has invalid enum.
INVALID_FILE_CONTENT File has invalid content.
INVALID_ID Id is invalid.
INVALID_IMAGE_SIZE Invalid image size
INVALID_INPUT_FORMAT Field has invalid format.
INVALID_NUMBER_FORMAT Field has invalid number format.
KEYWORD_DUPLICATED Keyword is duplicated.
KEYWORD_LENGTH_OUT_OF_RANGE Keyword is out of range.
LOCATION_NOT_MATCH_ACCOUNT_COUNTRY Targeting location is not matching with account country.
LOOKALIKE_WITH_SAME_PARAMETERS_ALREADY_EXISTS Same lookalike audience exists.
MEDIA_9_16_VIDEO_NOT_ALLOWED_EXCEPT_RNF 9:16 media is not allowed except R&F.
MEDIA_APP_REQUIRED Media app cannot be null.
MEDIA_APP_USING_AUDIENCE Media app is using audience.
MEDIA_APP_USING_IN_ACTIVE_ADGROUP Media app using in active adgroup
MEDIA_SIZE_NOT_SUPPORTED Media pixel size is not supported.
MEDIA_TYPE_NOT_MATCH_FILE_CONTENT Media type is not match with file content.
MEDIA_URL_APPROVED_ALREADY Media url already approved.
MEDIA_USING_IN_ACTIVE_AD Media using in active ad
NOT_ALLOWED_TO_MANAGE_DPA Managing dpa conversion is not allowed.
NOT_ALLOWED_TO_MANAGE_RNF Managing R&F conversion is not allowed.
NOT_ALLOWED_TO_MANAGE_WEBSITE_CONVERSION Managing website conversion is not allowed.
NOT_MULTIPLE_OF_CURRENCY_UNIT Currency is not allow multiple unit.
NO_FEED_SETTING Dpa feed is not set.
OPERATION_TIMEOUT Operation time exceed lock timeout limit.
OS_CANNOT_HAVE_MORE_THAN_ONE_OS_VERSION Os cannot have more than one os version.
OS_VERSION_REVERSED Min os version is bigger than max os version.
OUT_OF_RANGE Field is out of range.
PARTNER_PERMISSION_DENIED Partner permission denied.
REMOVED_ENTITY Entity already removed.
REQUIRED Required field is not set.
SOURCE_AUDIENCE_INSUFFICIENT Source audience insufficient
START_END_DATE_REVERSED Start date is later than end date.
TOO_HIGH Field is too high.
TOO_LOW Field is too low.
TOO_LOW_SPENDING_LIMIT Spending limit is too low.
TOO_MANY_ADVERTISING_IDS The number of adverting id exceeds limit.
TOO_MANY_KEYWORDS The number of keyword exceeds limit.
TOO_MANY_VALUES The number of values exceeds limit.
UNKNOWN Unknown error
UNSUPPORTED_CALL_TO_ACTION_BY_GAIN_FRIENDS_AD Unsupported call to action for gain friend campaign
UNSUPPORTED_MEDIA_TYPE_BY_GAIN_FRIENDS_AD Unsupported media type for gain friend campaign
VIDEO_COUNT_LIMIT_EXCEEDED The number of video in account exceeds limit