1. Overview

1.1. About This Document

This document describes API specification of Ads Management of LINE Ads.
This document is intended for the developers who use the API of Ads Management.

1.2. Version information

Version : 3.11.4

1.3. Contact information

Contact : LINE Ads API Support
Contact Email : ml-lads-api-support@lycorp.co.jp

Please fill out the following information when you make an inquiry.

Inquiries before API application
- Inquiries Details

Inquiries about API usage
- Group ID authorized by API
- Please indicate which of the API permissions you are using : LINE Ads API/Conversion API
- Inquiries Details

1.4. URI scheme

Host : ads.line.me
BasePath : /api
Schemes : HTTPS

1.5. Tags

  • LinkRequests : This API enables to request authority for adaccount which allow you to access its resources.

  • Groups : This API enables to manage groups authorized by API enabled group.

  • Adaccounts : This API enables to get adaccounts authorized by API enabled group.

  • Reports : This API enables to manage reports and download report csv file.

  • OnlineReports : This API enables to access reports in json format.

  • Campaigns : This API enables to manage campaigns.

  • Adgroups : This API enables to manage adgroups.

  • Ads : This API enables to manage ads.

  • Media : This API enables to manage media.

  • Codes : This API enables to access code specification.

  • Simulations : This API enables to simulate adgroup execution result.

2. Copyright

Copyright © LY Corporation All Rights Reserved.

This document is an intellectual property of LY Corporation; unauthorized reproduction or distribution of this document, or any portion of it is prohibited by law.
This document is provided for information purpose only. LY Corporation has endeavored to verify the completeness and accuracy of information contained in this document, but it does not take the responsibility for possible errors or omissions in this document. Therefore, the responsibility for the usage of this document or the results of the usage falls entirely upon the user, and LY Corporation does not make any explicit or implicit guarantee regarding this.
Software products or merchandises mentioned in this document, including relevant URL information, conform to the copyright laws of their respective owners. The user is solely responsible for any results occurred by not complying with applicable laws.
LY Corporation may modify the details of this document without prior notice.

3. Authentication

When you access Ads Management API, you have to provide the following items in the request header so the request can be authenticated.

Here are illustrative processes of signing a request.

  1. Activating a Group for accessing to this API
    We send an invitation email to your email address which is applied.
    It invites you to a Group which is associated with information for accessing to this API.

  2. Getting an Access key and a Secret key on the Group setting page of Ad Manager UI.

    transit to group setting

    At the first access, cannot see the secret key.
    So re-generating a secret key from the red marked link below.

    regenerate secret

  3. Generating a request for Ads Management API

    1. Calculating signature of a request
      This API authenticates your request with the signature based on JWS. So it is necessary to calculate a signature from your request with several operations below.

      1. Constructing JOSE Header
        Header is specified by JSON. It includes several claims below.

        key description

        alg

        The cryptographic algorithm for signature. Only "HS256" can be specified.

        kid

        This id is the access key which you can see on Ad Manager UI.

        type

        The content type of payload. Only "text/plain" can be specified.

        e.g.) Sample of Header

        {
  "alg": "HS256",
  "kid": "LINEADSAMPLE",
  "typ": "text/plain"
}

      2. Constructing JWS Payload
        Payload is specified by text/plain.
        Payload includes some parameters below, and those are concatenated with line feed(\n).

        parameter description

        Digest-SHA-256

        The hex string digest of SHA256 encoded request body.

        When there is no request body or Content-type is 'multipart/form-data', use ""(empty string) instead of request body to find Digest-SHA-256.

        Content-Type

        The content type of request body.
        e.g.) 'application/json', 'multipart/form-data'

        When Content-type is 'multipart/form-data', no 'boundary' value is needed.

        When there is no request body, this value should be ""(empty string).

        Date

        The date of generating the request. It should be in format of 'YYYYMMDD'.
        This value should match the value in 'Date' header.

        The value of 'Date' header should be in format RFC1123 and within the range of ±15 minutes from now.

        CanonicalURI

        Normalized URI of request.

        e.g.) Sample of a payload in the case that the request body is '{"name": "test group"}' represented by 'application/json' and it calls '/api/v3/groups/G1/children' at 2021/12/22 00:00:00 GMT.

        66d8e0f35d6568f4e58a63f0797c6a5c43838579f86ef14e1dd81fd75d19d3d5
application/json
20211222
/api/v3/groups/G1/children

      3. Calculating signature
        First, creating a JWS Signing Input Value from Header and Payload.
        Header and Payload are respectively encoded by base64, and those are concatenated with a comma.

        InputValue = Base64(Header).Base64(Payload)

        And then, calculating JWS signature from the InputValue with secret key.

        Signature = Base64(HMAC-SHA-256(secretKey, InputValue))

        In the end, concatenating InputValue and Signature with comma.

        InputValue.Signature

    2. Calling API with calculated signature.

      1. Setting HTTP Request Headers
        This API required some HTTP Request headers blow.

        Header name value

        Content-type

        The content type of the request. No needed if there is no request body.

        Date

        The timestamp of generating the request.

        Authorization

        Calculated signature with Bearer scheme.

        e.g) With request body

        Content-type: application/json
Date: Wed, 22 Dec 2021 00:00:00 GMT
Authorization: Bearer <Calculated Signature>

        e.g) Without request body

        Date: Wed, 22 Dec 2021 00:00:00 GMT
Authorization: Bearer <Calculated Signature>

3.1. Authentication Examples

With request body

  1. Getting an Access key and regenerating a Secret key on the Group page of Ad Manager UI.

  2. Calculating signature of a request.

    parameter name value

    Access key

    LINEADSAMPLE

    Secret key

    LINEADSECRETKEYSAMPLE

    Request body

    {"name":"test","campaignObjective":"VISIT_MY_WEBSITE"}

    Content type

    application/json

    Date

    Wed, 22 Dec 2021 00:00:00 GMT

    CanonicalURI

    /api/v3/adaccounts/A1/campaigns
    Header
    {"alg":"HS256","kid":"LINEADSAMPLE","typ":"text/plain"}
    Payload
    49c87c1eb6e5588582c13b15212973f6a3ef644872d48fca3252f69043522b1a
application/json
20211222
/api/v3/adaccounts/A1/campaigns
    Signature (with line breaks for display purposes only)
    eyJhbGciOiJIUzI1NiIsImtpZCI6IkxJTkVBRFNBTVBMRSIsInR5cCI6InRleHQvcGxhaW4ifQ==
.
NDljODdjMWViNmU1NTg4NTgyYzEzYjE1MjEyOTczZjZhM2VmNjQ0ODcyZDQ4ZmNhMzI1MmY2OTA0MzUyMmIxYQphcHBsaWNhdGlvbi9qc29uCjIwMjExMjIyCi9hcGkvdjMvYWRhY2NvdW50cy9BMS9jYW1wYWlnbnM=
.
Krh1Xh-kWldS-MkOmNH6dmMdkWDTBVmnkDCZHlMRUoo=

  3. Creating a campaign

    curl -X POST \
-H "Content-Type: application/json" \
-H "Date: Wed, 22 Dec 2021 00:00:00 GMT" \
-H "Authorization: Bearer {SIGNATURE}" \
-d '{"name":"test","campaignObjective":"VISIT_MY_WEBSITE"}' \
"https://ads.line.me/api/v3/adaccounts/A1/campaigns"

Without request body

  1. Getting an Access key and regenerating a Secret key on the Group page of Ad Manager UI.

  2. Calculating signature of a request.

    parameter name value

    Access key

    LINEADSAMPLE

    Secret key

    LINEADSECRETKEYSAMPLE

    Request body

    (Empty string)

    Content type

    (Empty string)

    Date

    Wed, 22 Dec 2021 00:00:00 GMT

    CanonicalURI

    /api/v3/adaccounts/A1/campaigns
    Header
    {"alg":"HS256","kid":"LINEADSAMPLE","typ":"text/plain"}
    Payload
    e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855

20211222
/api/v3/adaccounts/A1/campaigns
    Signature (with line breaks for display purposes only)
    eyJhbGciOiJIUzI1NiIsImtpZCI6IkxJTkVBRFNBTVBMRSIsInR5cCI6InRleHQvcGxhaW4ifQ==
.
ZTNiMGM0NDI5OGZjMWMxNDlhZmJmNGM4OTk2ZmI5MjQyN2FlNDFlNDY0OWI5MzRjYTQ5NTk5MWI3ODUyYjg1NQoKMjAyMTEyMjIKL2FwaS92My9hZGFjY291bnRzL0ExL2NhbXBhaWducw==
.
xHzIHHbWvIZUiek7Jy0fuyG6U0FQpobUyFXybcx9t4c=

  3. Read campaigns

    curl -X GET \
-H "Content-Type: application/json" \
-H "Date: Wed, 22 Dec 2021 00:00:00 GMT" \
-H "Authorization: Bearer {SIGNATURE}" \
"https://ads.line.me/api/v3/adaccounts/A1/campaigns?page=1&size=10"

3.2. Sample Code

create_child_group.py
import base64
import datetime
import hashlib
import hmac
import json
import urllib.request


def calc_sha256_digest(content: str) -> str:
    sha256 = hashlib.new('sha256')
    sha256.update(content.encode())
    return sha256.hexdigest()


def encode_with_base64(value: bytes) -> str:
    return base64.urlsafe_b64encode(value).decode()


if __name__ == '__main__':
    # Setting parameters for your request
    access_key = "<YOUR_ACCESS_KEY>"
    secret_key = "<YOUR_SECRET_KEY>"
    method = "POST"
    canonical_url = "/api/v3/groups/<YOUR_GROUP_ID>/children"
    url_parameters = ""
    request_body = {"name": "<YOUR_NEW_GROUP_NAME>"}
    has_request_body = request_body is not None

    endpoint = 'https://ads.line.me' + canonical_url + url_parameters
    request_body_json = json.dumps(request_body) if has_request_body else ""
    content_type = 'application/json' if has_request_body else ""

    jws_header = encode_with_base64(
        json.dumps({
            "alg": "HS256",
            "kid": access_key,
            "typ": "text/plain",
        }).encode()
    )

    hex_digest = calc_sha256_digest(request_body_json)
    payload_date = datetime.datetime.utcnow().strftime('%Y%m%d')
    payload = "%s\n%s\n%s\n%s" % (hex_digest, content_type, payload_date, canonical_url)
    jws_payload = encode_with_base64(payload.encode())

    signing_input = "%s.%s" % (jws_header, jws_payload)
    signature = hmac.new(
        secret_key.encode(),
        signing_input.encode(),
        hashlib.sha256
    ).digest()
    encoded_signature = encode_with_base64(signature)
    token = "%s.%s.%s" % (jws_header, jws_payload, encoded_signature)

    http_headers = {
        "Date": datetime.datetime.utcnow().strftime('%a, %d %b %Y %H:%M:%S GMT'),
        "Authorization": "Bearer %s" % token
    }

    if has_request_body:
        http_headers["Content-Type"] = content_type
        req = urllib.request.Request(endpoint, data=request_body_json.encode(), headers=http_headers, method=method)
    else:
        req = urllib.request.Request(endpoint, headers=http_headers, method=method)

    with urllib.request.urlopen(req) as res:
        resp = res.read()
    print(resp.decode())

4. Common specifications

4.1. 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

2 request / sec

4.2. Request Quota

Users are limited in the number of simultaneous API calls they can make. The limitation is applied for each API user and each API.

APIs subject to Request Quota will include related information in the response header:

Header Name Description

X-Request-Quota-Limit

The maximum Request Quota applied to a specific API.

X-Request-Quota-Used

The current number of Quotas used. You can make calls up to the Limit. Calls beyond the Limit will receive a response with the value, EXCEED_LIMIT

The limitations for each user in specif API are shown below.

API Limit

Report Online - Read

at most 30 simultaneous req
recommned about 20 concurrent threads for 3 second API calls

5. LADM v11.4.0 new features

A item of what’s new or changed in LADM v11.4.0

APIs Description

6. Resources

6.1. LinkRequests

This API enables to request authority for adaccount which allow you to access its resources.

read

GET /v3/groups/{groupId}/link-request
Description

Read link requests.
This API does not return link requests in CANCELED or UNLINKED status.

Parameters
Type Name Description Schema Default

Path

groupId
required

Group id.

string

Query

includeRemoved
optional

Includes removed entities if set true.

boolean

"false"

Query

page
optional

Page number.

integer

1

Query

size
optional

Page size.

integer

100

Query

sort
optional

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending.
Property is one of id, targetAdaccountId, status, createdDate.

string

"createdDate,desc"
Responses
HTTP Code Description Schema

200

successful operation

LinkRequests

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Produces

  • application/json

create

POST /v3/groups/{groupId}/link-request/adaccount
Description

Create adaccount link request.

Parameters
Type Name Description Schema

Path

groupId
required

Group id.

string

Body

body
required

LinkRequest
Responses
HTTP Code Description Schema

200

successful operation

LinkRequest

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Consumes

  • application/json

Produces

  • application/json

update

POST /v3/groups/{groupId}/link-request/{id}/{actionType}
Description

Update link request.

Parameters
Type Name Description Schema

Path

actionType
required

Action type of link request.
cancel - cancel waiting approval link request.
unlink - unlink approved link request.

enum (cancel, unlink)

Path

groupId
required

Group id.

string

Path

id
required

Entity id.

number
Responses
HTTP Code Description Schema

200

successful operation

LinkRequest

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Produces

  • application/json

6.2. Groups

This API enables to manage groups authorized by API enabled group.

read

GET /v3/groups/{groupId}/children
Description

Read child groups.

Parameters
Type Name Description Schema Default

Path

groupId
required

Group id.

string

Query

ids
optional

Entity ids.

< number > array(multi)

Query

page
optional

Page number.

integer

1

Query

size
optional

Page size.

integer

100

Query

sort
optional

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending.
Property is one of id, name, createdDate.

string

"createdDate,desc"
Responses
HTTP Code Description Schema

200

successful operation

Groups

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Produces

  • application/json

create

POST /v3/groups/{groupId}/children
Description

Create child group.

Parameters
Type Name Description Schema

Path

groupId
required

Group id.

string

Body

body
required

Group
Responses
HTTP Code Description Schema

200

successful operation

Group

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Consumes

  • application/json

Produces

  • application/json

update

POST /v3/groups/{groupId}
Description

Update group.

Parameters
Type Name Description Schema

Path

groupId
required

Group id.

string

Body

body
required

Group
Responses
HTTP Code Description Schema

200

successful operation

Groups

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Consumes

  • application/json

Produces

  • application/json

6.3. Adaccounts

This API enables to get adaccounts authorized by API enabled group.

read

GET /v3/groups/{groupId}/adaccounts
Description

Read adaccounts.

Parameters
Type Name Description Schema Default

Path

groupId
required

Group id.

string

Query

includeLinked
optional

Includes linked entities to propagated groups if set true.

boolean

"true"

Query

includeRemoved
optional

Includes removed entities if set true.

boolean

"false"

Query

name
optional

Name for search.

string

Query

page
optional

Page number.

integer

1

Query

size
optional

Page size.

integer

100

Query

sort
optional

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending.
Property is one of id, name, configuredStatus, currency, timezone, createdDate.

string

"createdDate,desc"
Responses
HTTP Code Description Schema

200

successful operation

Adaccounts

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Produces

  • application/json

6.4. Reports

This API enables to manage reports and download report csv file.

read

GET /v3/adaccounts/{adaccountId}/pfreports
Description

Read performance reports.

Parameters
Type Name Description Schema Default

Path

adaccountId
required

Adaccount id.

string

Query

ids
optional

Entity ids.

< number > array(multi)

Query

page
optional

Page number.

integer

1

Query

size
optional

Page size.

integer

100

Query

sort
optional

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending.
Property is one of id, name, status, createdDate.

string

"createdDate,desc"
Responses
HTTP Code Description Schema

200

successful operation

Reports

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Produces

  • application/json

create

POST /v3/adaccounts/{adaccountId}/pfreports
Description

Create performance report.
Reports for dates more than five years after the report reference date cannot be provided.

Parameters
Type Name Description Schema

Path

adaccountId
required

Adaccount id.

string

Body

body
required

ReportQueryParams
Responses
HTTP Code Description Schema

200

successful operation

Report

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Consumes

  • application/json

Produces

  • application/json

delete

DELETE /v3/adaccounts/{adaccountId}/pfreports/{id}
Description

Delete performance report.

Parameters
Type Name Description Schema

Path

adaccountId
required

Adaccount id.

string

Path

id
required

Entity id.

number
Responses
HTTP Code Description Schema

200

successful operation

No Content

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array

download

GET /v3/adaccounts/{adaccountId}/pfreports/{id}/download
Description

Download performance report.

  • This API returns a response body with 'text/csv;charset=utf-8' or 'text/csv;charset=utf-16le' (with BOM) format when the request succeeded.
    And it returns a response body with 'application/json' format when the request has some errors.

Parameters
Type Name Description Schema

Path

adaccountId
required

Adaccount id.

string

Path

id
required

Entity id.

number
Responses
HTTP Code Description Schema

200

successful operation

file

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Produces

  • text/csv;charset=utf-8

  • text/csv;charset=utf-16le

  • application/json

Report Fields by each Report level
Note
 SKAdNetwork-specific fields are only available in SKAdNetwork-enabled ad groups in ad accounts that have the SKAdNetwork feature enabled.
Name Description ADACCOUNT CAMPAIGN ADGROUP AD AD (Carousel only)

Day (optional)

Base date

✓

✓

✓

✓

✓

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

✓

✓

Title

Ad title or Carousel Slot Ad Title

✓

✓

Description

Ad Description or Carousel Slot Ad Description

✓

✓

Currency

Currency of the account.

✓

✓

✓

✓

Reach (estimated)

The estimated number of people who have seen ads.
This field is present only when report delivery type is null.

✓

✓

✓

✓

Frequency

Reach’s frequency cap.

✓

✓

✓

✓

Impressions

The number of impressions.

✓

✓

✓

✓

✓

Clicks

The number of clicks.

✓

✓

✓

✓

✓

CPM (cost per thousand impressions)

The number of CPM.

✓

✓

✓

✓

✓

CTR (click-through rate)

The number of CTR.

✓

✓

✓

✓

✓

CPC (cost per click)

The number of CPC.

✓

✓

✓

✓

Cost

The number of costs.

✓

✓

✓

✓

CV (conversions) or CV (LINE Tag clicks)

The number of conversions.

✓

✓

✓

✓

✓

CVR (conversion rate) or CVR (LINE Tag clicks)

The number of CVR.

✓

✓

✓

✓

✓

CPA (cost per action) or CPA (LINE Tag clicks)

The number of CPA.

✓

✓

✓

✓

CV (product details viewed) (ALL)

The number of "conversion (product details viewed) (ALL)" event

✓

✓

✓

✓

✓

CVR (product details viewed) (ALL)

The number of CVR in "CV (product details viewed) (ALL)"

✓

✓

✓

✓

✓

CPA (product details viewed) (ALL)

The number of CPA in "CV (product details viewed) (ALL)"

✓

✓

✓

✓

✓

CV (product details viewed)

The number of "conversion (product details viewed)" event

✓

✓

✓

✓

✓

CVR (product details viewed)

The number of CVR in "CV (product details viewed)"

✓

✓

✓

✓

✓

CPA (product details viewed)

The number of CPA in "CV (product details viewed)"

✓

✓

✓

✓

✓

CV (item added to cart) (ALL)

The number of "conversion (item added to cart) (ALL)" event

✓

✓

✓

✓

✓

CVR (item added to cart) (ALL)

The number of CVR in "CV (item added to cart) (ALL)"

✓

✓

✓

✓

✓

CPA (item added to cart) (ALL)

The number of CPA in "CV (item added to cart) (ALL)"

✓

✓

✓

✓

✓

CV (item added to cart)

The number of "conversion (item added to cart)" event

✓

✓

✓

✓

✓

CVR (item added to cart)

The number of CVR in "CV (item added to cart)"

✓

✓

✓

✓

✓

CPA (item added to cart)

The number of CPA in "CV (item added to cart)"

✓

✓

✓

✓

✓

CV (checkout started) (ALL)

The number of "conversion (checkout started) (ALL)" event

✓

✓

✓

✓

✓

CVR (checkout started) (ALL)

The number of CVR in "CV (checkout started) (ALL)"

✓

✓

✓

✓

✓

CPA (checkout started) (ALL)

The number of CPA in "CV (checkout started) (ALL)"

✓

✓

✓

✓

✓

CV (checkout started)

The number of "conversion (checkout started)" event

✓

✓

✓

✓

✓

CVR (checkout started)

The number of CVR in "CV (checkout started)"

✓

✓

✓

✓

✓

CPA (checkout started)

The number of CPA in "CV (checkout started)"

✓

✓

✓

✓

✓

CV (purchased) (ALL)

The number of "conversion (purchased) (ALL)" event

✓

✓

✓

✓

✓

CVR (purchased) (ALL)

The number of CVR in "CV (purchased) (ALL)"

✓

✓

✓

✓

✓

CPA (purchased) (ALL)

The number of CPA in "CV (purchased) (ALL)"

✓

✓

✓

✓

✓

CV (purchased)

The number of "conversion (purchased)" event

✓

✓

✓

✓

✓

CVR (purchased)

The number of CVR in "CV (purchased)"

✓

✓

✓

✓

✓

CPA (purchased)

The number of CPA in "CV (purchased)"

✓

✓

✓

✓

✓

CV value (purchased)

The value of "Conversion Purchase" event

✓

✓

✓

✓

✓

CV value (purchased) (click)

The value of "Conversion Purchase (clicks)" event

✓

✓

✓

✓

✓

ROAS

Return on ads spend for purchase (all) event

✓

✓

✓

✓

✓

ROAS (click)

Return on ads spend for purchase (clicks) event

✓

✓

✓

✓

✓

CV (lead generated) (ALL)

The number of "conversion (lead generated) (ALL)" event

✓

✓

✓

✓

✓

CVR (lead generated) (ALL)

The number of CVR in "CV (lead generated) (ALL)"

✓

✓

✓

✓

✓

CPA (lead generated) (ALL)

The number of CPA in "CV (lead generated) (ALL)"

✓

✓

✓

✓

✓

CV (lead generated)

The number of "conversion (lead generated)" event

✓

✓

✓

✓

✓

CVR (lead generated)

The number of CVR in "CV (lead generated)"

✓

✓

✓

✓

✓

CPA (lead generated)

The number of CPA in "CV (lead generated)"

✓

✓

✓

✓

✓

CV (reservation completed) (ALL)

The number of "conversion (reservation completed) (ALL)" event

✓

✓

✓

✓

✓

CVR (reservation completed) (ALL)

The number of CVR in "CV (reservation completed) (ALL)"

✓

✓

✓

✓

✓

CPA (reservation completed) (ALL)

The number of CPA in "CV (reservation completed) (ALL)"

✓

✓

✓

✓

✓

CV (reservation completed)

The number of "conversion (reservation completed)" event

✓

✓

✓

✓

✓

CVR (reservation completed)

The number of CVR in "CV (reservation completed)"

✓

✓

✓

✓

✓

CPA (reservation completed)

The number of CPA in "CV (reservation completed)"

✓

✓

✓

✓

✓

CV (signup completed) (ALL)

The number of "conversion (signup completed) (ALL)" event

✓

✓

✓

✓

✓

CVR (signup completed) (ALL)

The number of CVR in "CV (signup completed) (ALL)"

✓

✓

✓

✓

✓

CPA (signup completed) (ALL)

The number of CPA in "CV (signup completed) (ALL)"

✓

✓

✓

✓

✓

CV (signup completed)

The number of "conversion (signup completed)" event

✓

✓

✓

✓

✓

CVR (signup completed)

The number of CVR in "CV (signup completed)"

✓

✓

✓

✓

✓

CPA (signup completed)

The number of CPA in "CV (signup completed)"

✓

✓

✓

✓

✓

CV API

The number of CV API

✓

✓

✓

✓

✓

CV (All)

The number of CV + CV API + Engagement view conversion

✓

✓

✓

✓

✓

CVR (All)

The number of CVR in "CV (All)"

✓

✓

✓

✓

✓

CPA (All)

The number of CPA in "CV (All)"

✓

✓

✓

✓

✓

CV (LINE tag + CV API)

The number of CV + CV API

✓

✓

✓

✓

✓

CVR (LINE tag + CV API)

The number of CVR in "CV (LINE tag + CV API)"

✓

✓

✓

✓

✓

CPA (LINE tag + CV API)

The number of CPA in "CV (LINE tag + CV API)"

✓

✓

✓

✓

✓

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)

✓

✓

✓

✓

✓

Installs (ALL)

The number of events of App install.
(Click + View through conversion + Engagement view conversion)

✓

✓

✓

✓

✓

Installs (SKAN clicks)

The number of events of App install measured by SKAdNetwork.

✓

✓

✓

Install rate (clicks)

The ratio of events of App install to clicks.
(Click through conversion)

✓

✓

✓

✓

✓

Install rate (ALL)

The ratio of events of App install to clicks.
(Click through conversion + View through conversion + Engagement view conversion)

✓

✓

✓

✓

✓

Install rate (SKAN clicks)

The ratio of events of App install measured by SKAdNetwork to clicks.

✓

✓

✓

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)

✓

✓

✓

✓

Cost per install (ALL)

The costs per an event of App install.
(Click + View through conversion + Engagement view conversion)

✓

✓

✓

✓

Cost per install (SKAN clicks)

The costs per an event of App install measured by SKAdNetwork.

✓

✓

✓

Open (ALL)

The number of events of App opening with engagement view conversion.

✓

✓

✓

✓

✓

Open rate (ALL)

The ratio of events of App opening to clicks with engagement view conversion.

✓

✓

✓

✓

✓

Cost per open (ALL)

The costs per an event of App opening with engagement view 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 screen (ALL)

The number of events of the home screen views in the App with engagement view conversion.

✓

✓

✓

✓

✓

Home screen view rate (ALL)

The ratio of events of the home screen views in the App to clicks with engagement view conversion.

✓

✓

✓

✓

✓

Cost per view (home) (ALL)

The costs per an event of the home view in the App with engagement view conversion.

✓

✓

✓

✓

View home screen

The number of events of the home screen views in the App.

✓

✓

✓

✓

✓

Home screen view rate

The ratio of events of the home screen views in the App to clicks.

✓

✓

✓

✓

✓

Cost per view (home)

The costs per an event of the home view in the App.

✓

✓

✓

✓

Category view (ALL)

The number of events of the category views in the App with engagement view conversion.

✓

✓

✓

✓

✓

Category view rate (ALL)

The ratio of events of the category views in the App to clicks with engagement view conversion.

✓

✓

✓

✓

✓

Cost per view (category) (ALL)

The costs per an event of the category view in the App with engagement view conversion.

✓

✓

✓

✓

Category view

The number of events of the category views in the App.

✓

✓

✓

✓

✓

Category view 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 product (ALL)

The number of events of the product views in the App with engagement view conversion.

✓

✓

✓

✓

✓

Product view rate (ALL)

The ratio of events of the product views in the App to clicks with engagement view conversion.

✓

✓

✓

✓

✓

Cost per view (product) (ALL)

The costs per an event of the item view in the App with engagement view conversion.

✓

✓

✓

✓

View product

The number of events of the product views in the App.

✓

✓

✓

✓

✓

Product view rate

The ratio of events of the product views in the App to clicks.

✓

✓

✓

✓

✓

Cost per view (product)

The costs per an event of the item view in the App.

✓

✓

✓

✓

Search (ALL)

The number of events of search in the App with engagement view conversion.

✓

✓

✓

✓

✓

Search rate (ALL)

The ratio of the number of events of search in the App to clicks with engagement view conversion.

✓

✓

✓

✓

✓

Cost per search (ALL)

The costs per an event of search in the App with engagement view conversion.

✓

✓

✓

✓

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 (ALL)

The number of events of adding to cart in the App with engagement view conversion.

✓

✓

✓

✓

✓

Add-to-cart rate (ALL)

The ratio of the number of events of adding to cart in the App to clicks with engagement view conversion.

✓

✓

✓

✓

✓

Cost per add-to-cart (ALL)

The costs per an event of adding to cart in the App with engagement view conversion.

✓

✓

✓

✓

✓

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 (ALL)

The number of events of purchase in the App with engagement view conversion.

✓

✓

✓

✓

✓

Purchase rate (ALL)

The ratio of events of purchase in the App to clicks with engagement view conversion.

✓

✓

✓

✓

✓

Cost per purchase (ALL)

The costs per an event of purchase in the App with engagement view conversion.

✓

✓

✓

✓

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 (ALL)

The number of events of achieved the level in the App with engagement view conversion.

✓

✓

✓

✓

✓

Level achieved rate (ALL)

The ratio of the number of events of achieved the level in the App to clicks with engagement view conversion.

✓

✓

✓

✓

✓

Cost per level achieved (ALL)

The costs per an event of achieved the level in the App with engagement view conversion.

✓

✓

✓

✓

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 (ALL)

The number of events of completed the tutorial in the App with engagement view conversion.

✓

✓

✓

✓

✓

Tutorial percent complete (ALL)

The ratio of the number of events of completed the tutorial in the App to clicks with engagement view conversion.

✓

✓

✓

✓

✓

Cost per tutorial completion (ALL)

The costs per an event of completed the tutorial in the App with engagement view conversion.

✓

✓

✓

✓

Tutorial complete

The number of events of completed the tutorial in the App.

✓

✓

✓

✓

✓

Tutorial percent complete

The ratio of the number of events of completed the tutorial in the App to clicks.

✓

✓

✓

✓

✓

Cost per tutorial completion

The costs per an event of completed the tutorial in the App.

✓

✓

✓

✓

<Custom conversion name>

The number of events in 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 in 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 in 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 (100% watched)

The number of completions watching a video.

✓

✓

✓

✓

Cost per complete video view

The costs per The number of completions watching a video in the App

✓

✓

✓

✓

Video (viewed for at least three seconds)

The number of watching a video during 3 seconds.

✓

✓

✓

✓

Cost per 3-second playback

The costs per 3-second Video views in the App.

✓

✓

✓

✓

Video (25% watched)

The number of watching a video by 25%.

✓

✓

✓

✓

Video (50% watched)

The number of watching a video by 50%.

✓

✓

✓

✓

Video (75% watched)

The number of watching a video by 75%.

✓

✓

✓

✓

Video (95% watched)

The number of watching a video by 95%.

✓

✓

✓

✓

download sample

GET /v3/adaccounts/{adaccountId}/pfreports/{id}/download/sample
Description

Download performance report sample.

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

  • 5 levels of reports are available. Each report can be downloaded to specify the id assigned for each one.

Report level Id

ADACCOUNT

1

CAMPAIGN

2

ADGROUP

3

AD

4

AD (Carousel only)

5

  • This API returns a response body with 'text/csv;charset=utf-8' or 'text/csv;charset=utf-16le' (with BOM) format when the request succeeded.
    And it returns a response body with 'application/json' format when the request has some errors.

Parameters
Type Name Description Schema

Path

adaccountId
required

Adaccount id.

string

Path

id
required

Entity id.

number
Responses
HTTP Code Description Schema

200

successful operation

file

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Produces

  • text/csv;charset=utf-8

  • text/csv;charset=utf-16le

  • application/json

6.5. OnlineReports

This API enables to access reports in json format.

read

GET /v3/adaccounts/{adaccountId}/reports/online/{reportLevel}
Description

Read online reports.

Parameters
Type Name Description Schema Default

Path

adaccountId
required

Adaccount id.

string

Path

reportLevel
required

The level of report to get.

enum (campaign, adgroup, ad)

Query

adgroupId
optional

Adgroup id.

number

Query

campaignId
optional

Campaign id.

number

Query

includeRemoved
optional

Includes removed entities if set true.

boolean

"false"

Query

lpId
optional

The landing page id to filter on the report.

number

Query

page
optional

Page number.

integer

1

Query

searchKey
optional

The id or name to search.

string

Query

since
optional

The date to receive after data from it in YYYY-MM-DD format. (eg. 2021-12-21)

string (date)

Query

size
optional

Page size.
Maximum Value: 100

integer

20

Query

until
optional

The date to receive previous data from it in YYYY-MM-DD format. (eg. 2021-12-22)

string (date)
Responses
HTTP Code Description Schema

200

successful operation

ReportOnlineResponse

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Produces

  • application/json

6.6. Campaigns

This API enables to manage campaigns.

read

GET /v3/adaccounts/{adaccountId}/campaigns
Description

Read campaigns.

Parameters
Type Name Description Schema Default

Path

adaccountId
required

Adaccount id.

string

Query

ids
optional

Entity ids.

< number > array(multi)

Query

includeRemoved
optional

Includes removed entities if set true.

boolean

"false"

Query

page
optional

Page number.

integer

1

Query

size
optional

Page size.

integer

100

Query

sort
optional

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending.
Property is one of id, name, campaignObjective, configuredStatus, spendingLimitMicro, startDate, endDate, createdDate.

string

"createdDate,desc"
Responses
HTTP Code Description Schema

200

successful operation

Campaigns

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Produces

  • application/json

6.7. Adgroups

This API enables to manage adgroups.

read

GET /v3/adaccounts/{adaccountId}/adgroups
Description

Read adgroups.

Parameters
Type Name Description Schema Default

Path

adaccountId
required

Adaccount id.

string

Query

campaignId
optional

Campaign id.

number

Query

ids
optional

Entity ids.

< number > array(multi)

Query

includeRemoved
optional

Includes removed entities if set true.

boolean

"false"

Query

page
optional

Page number.

integer

1

Query

size
optional

Page size.

integer

100

Query

sort
optional

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending.
Property is one of id, name, campaignId, configuredStatus, bidType, bidAmountMicro, createdDate.

string

"createdDate,desc"
Responses
HTTP Code Description Schema

200

successful operation

Adgroups

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Produces

  • application/json

6.8. Ads

This API enables to manage ads.

read

GET /v3/adaccounts/{adaccountId}/ads
Description

Read ads.

Parameters
Type Name Description Schema Default

Path

adaccountId
required

Adaccount id.

string

Query

adgroupId
optional

Adgroup id.

number

Query

campaignId
optional

Campaign id.

number

Query

ids
optional

Entity ids.

< number > array(multi)

Query

includeRemoved
optional

Includes removed entities if set true.

boolean

"false"

Query

mediaId
optional

Media id.

number

Query

page
optional

Page number.

integer

1

Query

size
optional

Page size.

integer

100

Query

sort
optional

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending.
Property is one of id, name, adgroupId, creative.id, configuredStatus, createdDate.

string

"createdDate,desc"
Responses
HTTP Code Description Schema

200

successful operation

Ads

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Produces

  • application/json

6.9. Media

This API enables to manage media.

read

GET /v3/adaccounts/{adaccountId}/media
Description

Read media.

Parameters
Type Name Description Schema Default

Path

adaccountId
required

Adaccount id.

string

Query

ids
optional

Entity ids.

< number > array(multi)

Query

page
optional

Page number.

integer

1

Query

size
optional

Page size.

integer

100

Query

sort
optional

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending.
Property is one of id, name, mimeType, createdDate.

string

"createdDate,desc"
Responses
HTTP Code Description Schema

200

successful operation

Medias

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Produces

  • application/json

6.10. Codes

This API enables to access code specification.

ssps

GET /v3/codes/ssps
Description

get ssp codes.

Parameters
Type Name Description Schema

Query

locale
optional

The locale.

enum (ja, th, zh_TW, en)
Responses
HTTP Code Description Schema

200

successful operation

< Code > array

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Produces

  • application/json

placements

GET /v3/codes/placements
Description

get placement codes.

Parameters
Type Name Description Schema

Query

country
required

The country.

enum (JP, TH, TW)

Query

locale
optional

The locale.

enum (ja, th, zh_TW, en)
Responses
HTTP Code Description Schema

200

successful operation

< Code > array

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Produces

  • application/json

ages

GET /v3/codes/ages
Description

get age codes.

Parameters
Type Name Description Schema

Query

country
optional

The country.

enum (JP, TH, TW)
Responses
HTTP Code Description Schema

200

successful operation

< AgeCode > array

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Produces

  • application/json

genders

GET /v3/codes/genders
Description

get gender codes.

Parameters
Type Name Description Schema

Query

locale
optional

The locale.

enum (ja, th, zh_TW, en)
Responses
HTTP Code Description Schema

200

successful operation

< Code > array

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Produces

  • application/json

os

GET /v3/codes/os
Description

get OS codes.

Parameters
Type Name Description Schema

Query

locale
optional

The locale.

enum (ja, th, zh_TW, en)
Responses
HTTP Code Description Schema

200

successful operation

< OsCode > array

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Produces

  • application/json

call to actions

GET /v3/codes/call-to-actions
Description

get call to action codes.

Parameters
Type Name Description Schema

Query

campaignObjective
optional

The objective of campaign.

enum (VISIT_MY_WEBSITE, APP_INSTALL, APP_ENGAGEMENT, WEBSITE_CONVERSION, DYNAMIC_PRODUCT, GAIN_FRIENDS, VIDEO_VIEW)

Query

locale
optional

The locale.

enum (ja, th, zh_TW, en)
Responses
HTTP Code Description Schema

200

successful operation

< Code > array

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Produces

  • application/json

geo delivery targets

GET /v3/codes/geo-delivery-targets
Description

get geo delivery target codes.

Parameters
Type Name Description Schema

Query

locale
optional

The locale.

enum (ja, th, zh_TW, en)
Responses
HTTP Code Description Schema

200

successful operation

< Code > array

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Produces

  • application/json

areas

GET /v3/codes/areas
Description

get area codes.

Parameters
Type Name Description Schema

Query

country
optional

The country.

enum (JP, TH, TW)

Query

locale
optional

The locale.

enum (ja, th, zh_TW, en)
Responses
HTTP Code Description Schema

200

successful operation

< AreaCode > array

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Produces

  • application/json

advanced targeting

GET /v3/codes/advanced-targeting
Description

get advanced targeting codes.

Parameters
Type Name Description Schema

Query

campaignObjective
optional

The objective of campaign.

enum (VISIT_MY_WEBSITE, APP_INSTALL, APP_ENGAGEMENT, WEBSITE_CONVERSION, DYNAMIC_PRODUCT, GAIN_FRIENDS, VIDEO_VIEW)

Query

country
optional

The country.

enum (JP, TH, TW)

Query

locale
optional

The locale.

enum (ja, th, zh_TW, en)
Responses
HTTP Code Description Schema

200

successful operation

AdvancedTargetingCodes

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Produces

  • application/json

6.11. Simulations

This API enables to simulate adgroup execution result.

ars

POST /v3/adaccounts/{adaccountId}/simulation/ars
Description

Execute ARS. (Adgroup Result Simulator)

Parameters
Type Name Description Schema

Path

adaccountId
required

Adaccount id.

string

Body

body
required

ArsSimulationRequest
Responses
HTTP Code Description Schema

200

successful operation

ArsSimulationResult

400

Problem with the request

< Errors > array

401

The token specified in 'Authorization' header is invalid.

< Errors > array

403

Not authorized to use the API. Confirm that your adaccount is authorized to used the API.

< Errors > array

422

when some fields values are absent or invalid.

ArsSimulationResult

429

Exceeded the rate limit for API calls.

No Content

500

Error on the internal server.

< Errors > array
Consumes

  • application/json

Produces

  • application/json

7. Definitions

7.1. Adaccounts

Name Schema

paging
optional
read-only

Paging

datas
optional
read-only

< Adaccount > array

7.2. Paging

Name Description Schema

page
optional
read-only

Page number.
Example : 1

integer

size
optional
read-only

Page size.
Example : 100

integer

totalElements
optional
read-only

Total number of elements.
Example : 200

integer

sorts
optional
read-only

Sort properties and sort orders.
Example : [ "createdDate,DESC" ]

< string > array

7.3. Adaccount

If field is required and readOnly, it can be used and required in READ, DOWNLOAD operation, but can’t be used and not required in CREATE, UPDATE, DELETE operation.

Name Description Schema

id
required
read-only

Id of this account.

number

name
required
read-only

The name of this adaccount.

string

configuredStatus
optional
read-only

The status of this adaccount.

enum (ACTIVE, PAUSED, REMOVED)

productType
required

Product type of this adaccount.
Adaccount for performance has PERFORMANCE type.
Adaccount for reservation ads has BRAND type.

enum (PERFORMANCE, BRAND)

availableCampaignObjective
required
read-only

Available campaign objectives for this adaccount.

< enum (VISIT_MY_WEBSITE, APP_INSTALL, APP_ENGAGEMENT, WEBSITE_CONVERSION, DYNAMIC_PRODUCT, GAIN_FRIENDS, VIDEO_VIEW) > array

currency
required
read-only

The currency of this adaccount.

string

timezone
required
read-only

The timezone of this adaccount.

string

country
required
read-only

The country of this adaccount.

string

lineAccount
optional

LineAccount

deliveryStatus
optional
read-only

The status of delivery ad.

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

deliveryStatusReasons
optional
read-only

The reason of delivery status.

< DeliveryStatusReason > array

createdDate
optional
read-only

The created date in ISO 8601 format and in adaccount timezone.
Example : "2021-12-22T14:28:56+09:00"

string (date)

modifiedDate
optional
read-only

The last modified date in ISO 8601 format and in adaccount timezone.
Example : "2021-12-22T14:30:51+09:00"

string (date)

removedDate
optional
read-only

The removed date in ISO 8601 format and in adaccount timezone.
Example : "2021-12-22T19:39:03+09:00"

string (date)

7.4. LineAccount

Name Description Schema

name
optional
read-only

The name of LINE account.

string

lineId
optional

The ID of LINE account.

string

7.5. DeliveryStatusReason

Name Description Schema

code
optional
read-only

The delivery status reason code.

string

7.6. Errors

Name Description Schema

errors
optional
read-only

List of occurred error.

< Error > array

7.7. Error

Name Description Schema

reason
optional
read-only

The reason of the error.

string

property
optional
read-only

The property which caused the error.

string

7.8. Groups

Name Schema

paging
optional
read-only

Paging

datas
optional
read-only

< Group > array

7.9. Group

If field is required and readOnly, it can be used and required in READ, DOWNLOAD operation, but can’t be used and not required in CREATE, UPDATE, DELETE operation.

Name Description Schema

id
required
read-only

The id of this group.

string

name
optional

The name of this group.

string

parentGroupId
required
read-only

The id of parent group.

string

parentGroupName
optional
read-only

The name of parent group.

string

depth
required
read-only

The number of ancestor groups.

number

createdDate
optional
read-only

The created date in ISO 8601 format and in adaccount timezone.
Example : "2021-12-22T14:28:56+09:00"

string (date)

modifiedDate
optional
read-only

The last modified date in ISO 8601 format and in adaccount timezone.
Example : "2021-12-22T14:30:51+09:00"

string (date)

removedDate
optional
read-only

The removed date in ISO 8601 format and in adaccount timezone.
Example : "2021-12-22T19:39:03+09:00"

string (date)

7.10. LinkRequests

Name Schema

paging
optional
read-only

Paging

datas
optional
read-only

< LinkRequest > array

7.11. LinkRequest

Name Description Schema

id
optional

Id of this link request.

number

sourceGroupId
optional

Id of the source group which is requesting for link.

string

sourceGroupName
optional
read-only

Name of the source group which is requesting for link.

string

targetAdaccountId
optional

Id of the adaccount to be requested for link.

string

targetAdaccountName
optional
read-only

Name of the adaccount to be requested for link.

string

status
optional
read-only

The status of approval by entity requested for link.

enum (WAITING_APPROVAL, REJECTED, LINKED, CANCELED, UNLINKED)

targetType
optional

Target entity type.

enum (ADACCOUNT)

createdDate
optional
read-only

The created date in ISO 8601 format and in UTC.
This is the date of requested for link.
Example : "2021-12-03T07:49:13Z"

string (date)

modifiedDate
optional
read-only

The last modified date in ISO 8601 format and in UTC.
This is the date of approval for the link if the status is LINKED.
Example : "2021-12-03T07:49:13Z"

string (date)

removedDate
optional
read-only

The removed date in ISO 8601 format and in UTC.
Example : "2021-12-03T07:49:13Z"

string (date)

7.12. Campaigns

Name Schema

paging
optional
read-only

Paging

datas
optional
read-only

< Campaign > array

7.13. Campaign

If field is required and readOnly, it can be used and required in READ, DOWNLOAD operation, but can’t be used and not required in CREATE, UPDATE, DELETE operation.

Name Description Schema

id
required
read-only

Id of this campaign.

number

name
required

Name of this campaign.
Length : 1 - 120

string

campaignObjective
required

The objective of this campaign.

enum (VISIT_MY_WEBSITE, APP_INSTALL, APP_ENGAGEMENT, WEBSITE_CONVERSION, DYNAMIC_PRODUCT, GAIN_FRIENDS, VIDEO_VIEW)

configuredStatus
optional

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

enum (ACTIVE, PAUSED, REMOVED)

spendingLimitType
required

The type of spending limit.
NONE - No spending limit.
MONTHLY - Spending limit is monthly budget.
LIFETIME - Spending limit is total budget.

enum (NONE, MONTHLY, LIFETIME)

spendingLimitMicro
optional

The spending limit of this campaign in micros and in adaccount currency.
Campaigns that reach their spending limit will be paused automatically.
Example : 1000000000000

integer (int64)

startDate
required

The date of starting to delivery ads in ISO 8601 format and in adaccount timezone.
Example : "2021-12-20T17:19:00+09:00"

string (date)

endDate
optional

The date of suspending delivering ads in ISO 8601 format and in adaccount timezone.
The value '1970-01-01T00:00:00Z' means the campaign runs indefinitely.
Set this field to '1970-01-01T00:00:00Z' if you want to erase endDate.
Example : "2021-12-22T13:42:00+09:00"

string (date)

activeCbo
optional

Campaign budget optimization allows your campaign to split its daily budget between multiple ad groups based on their performance.
High-performing ad groups will receive a higher share of the budget with the goal of spending all of your campaign’s daily budget.
This field cannot be modified.
Default : false

boolean

bidStrategy
optional

This is your bidding strategy for campaign budget optimization.
It applies to all adgroups in the campaign.
You’ll set this strategy when making a new campaign and won’t be able to change it when making or editing adgroups.
This field can be used when activeCbo is true.
This field cannot be modified.
LOWEST_COST - No limit; expend daily budget as aggressively as possible
COST_CAP - Set a target event cost cap
TARGET_COST - Set target event cost
TARGET_ROAS - Set target ROAS. AutoBidType must be set to CV_VALUE_STANDARD_PURCHASE.

enum (LOWEST_COST, COST_CAP, TARGET_COST, TARGET_ROAS)

dailyBudgetMicro
optional

This is the daily budget used by your campaign for budget optimization.
This budget is split between the campaign’s adgroups.
You’ll set this budget when making a new campaign and won’t be able to change it when making or editing adgroups.
Daily budget in micros and in adaccount currency.
This field can be used when activeCbo is true.
Example : 120000000000

integer (int64)

deliveryStatus
optional
read-only

The status of delivery ad.

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

deliveryStatusReasons
optional
read-only

The reason of delivery status.

< DeliveryStatusReason > array

createdDate
optional
read-only

The created date in ISO 8601 format and in adaccount timezone.
Example : "2021-12-22T14:28:56+09:00"

string (date)

modifiedDate
optional
read-only

The last modified date in ISO 8601 format and in adaccount timezone.
Example : "2021-12-22T14:30:51+09:00"

string (date)

removedDate
optional
read-only

The removed date in ISO 8601 format and in adaccount timezone.
Example : "2021-12-22T19:39:03+09:00"

string (date)

7.14. Adgroups

Name Schema

paging
optional
read-only

Paging

datas
optional
read-only

< Adgroup > array

7.15. Adgroup

If field is required and readOnly, it can be used and required in READ, DOWNLOAD operation, but can’t be used and not required in CREATE, UPDATE, DELETE operation.

Name Description Schema

id
required
read-only

Id of this adgroup.

number

campaignId
required

Id of campaign as parent of this adgroup.

number

name
required

Name of this adgroup.
Length : 1 - 120

string

mediaApp
optional

App media of this adgroup.

Media

configuredStatus
optional

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

enum (ACTIVE, PAUSED, REMOVED)

adgroupLearning
optional
read-only

Adgroup learning information.

AdgroupLearning

bidType
required

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

enum (CPC, CPF, CPM)

bidAmountMicro
optional

Bid amount in micros and in adaccount currency.
This field is used as bid amount, max cpc, max cpa, etc depending on the autoBidType.
Example : 100000000

integer (int64)

targetRoas
optional

Target ROAS (Return on Ad Spend) to be used when bidStrategy is set to TARGET_ROAS.
This field is percentage value with a range of 1% to 100_000%.
Example : 100000

integer (int64)

bidStrategy
optional

The strategy of auto bidding.
This field must be filled when using autoBidType other than MANUAL.
When using lowest cost option, bidAmountMicro must be null.
LOWEST_COST - No limit; expend daily budget as aggressively as possible
COST_CAP - Set a target event cost cap
TARGET_COST - Set target event cost
TARGET_ROAS - Set target ROAS. AutoBidType must be set to CV_VALUE_STANDARD_PURCHASE.

enum (LOWEST_COST, COST_CAP, TARGET_COST, TARGET_ROAS)

dailyBudgetMicro
optional

Daily budget in micros and in adaccount currency.
Example : 120000000000

integer (int64)

autoBidType
optional

The type of auto bidding.

enum (MANUAL, CLICK, CONVERSION, CUSTOM_CONVERSION, STANDARD_CV_PURCHASE, CV_INSTALL, CV_OPEN, FRIEND, VIDEO_VIEW_3S, VIDEO_VIEW_COMPLETION, REACH, CV_SKADNETWORK, CV_LEAD, CV_VALUE_STANDARD_PURCHASE)

autoBidConversionId
optional

The custom conversion id.
Custom conversion can be used under following conditions,
- autoBidType of adgroup is CUSTOM_CONVERSION.
- Attribution period of custom conversion is less than or equal to 30.
- Last contact date of custom conversion is not null.

string

firstAutoBidConversionId
optional
read-only

The first custom conversion id set to this adgroup.
When the adgroup is edited and becomes custom conversion adgroup again later,
the custom conversion id must be the one that is set first.

string

activateSkAdNetworkReporting
optional

Select this if you’re using SKAdNetwork tracking with this ad group.

boolean

targeting
optional

Targeting of this adgroup.

Targeting

dpaDestinationType
optional

The type of DPA destination. (DPA only)

enum (APP_STORE_URL, WEB_URL, TRACKING_URL_CMS)

dpaDestinationUrl
optional

The url of DPA destination. (DPA only)

string

productSetId
optional

The product set id (DPA only)

string

dpaFeedType
optional

The dpa feed type. (DPA only)
If dpaFeedType set to PRODUCT_SET, it mandatory needs productSetId.

enum (CATALOG, PRODUCT_SET)

rnfStartDate
optional

Reach’s start date in ISO 8601 format and in adaccount timezone.
Example : "2021-11-28T04:28:14+09:00"

string (date)

rnfEndDate
optional

Reach’s end date in ISO 8601 format and in adaccount timezone.
Example : "2021-11-28T04:28:14+09:00"

string (date)

rnfFrequency
optional

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

number

rnfFrequencyInterval
optional

Reach’s frequency interval.
Time interval which frequency resets for the ad group.
Minimum value : 1
Maximum value : 31

number

inStreamVideoIncluded
optional

Whether this adgroup is in-stream type or not.
* adaccount’s country must be TW
* campaign objective can use video creative format
* adgroup’s autoBidType is MANUAL

boolean

allowlist
optional

Adgroup LFP allow list
* create payload example: {… "allowlist": "id" …}
* update payload example: {… "allowlist": "id" …}
* remove payload example: {… "allowlist": {} …}

Allowlist

generatedByAi
optional

Flag for checking the media is generated by AI.
* Only required in TW adgroups under DPA campaigns.

boolean

deliveryStatus
optional
read-only

The status of delivery ad.

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

deliveryStatusReasons
optional
read-only

The reason of delivery status.

< DeliveryStatusReason > array

createdDate
optional
read-only

The created date in ISO 8601 format and in adaccount timezone.
Example : "2021-12-22T14:28:56+09:00"

string (date)

modifiedDate
optional
read-only

The last modified date in ISO 8601 format and in adaccount timezone.
Example : "2021-12-22T14:30:51+09:00"

string (date)

removedDate
optional
read-only

The removed date in ISO 8601 format and in adaccount timezone.
Example : "2021-12-22T19:39:03+09:00"

string (date)

7.16. Media

Name Description Schema

id
optional

Id of this media.

number

name
optional

The name of this media.

string

mediaType
optional

The type of media.

enum (IMAGE, VIDEO, APP, URL, ANIMATION)

mimeType
optional
read-only

The type of content of this media.

string

width
optional
read-only

Horizontal length of this media.

number

height
optional
read-only

Vertical length of this media.

number

fileSize
optional
read-only

File size of this media.

number

duration
optional
read-only

Duration time of video.

number

loops
optional
read-only

Loops of this animated media.

number

frames
optional
read-only

Frames of this animated media.

number

object
optional

Obs object information.

ObsObject

osCode
optional

The name of mobile operating system.

enum (IOS, ANDROID)

appstoreUrl
optional

The url of the page for that app on store.

string

appBundle
optional

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

string

affectedAdCount
optional
read-only

Number of ads affected.

number

url
optional

Url of this media.

string

lastLpRejectedDate
optional
read-only

The last rejected date of this media url in ISO 8601 format and in UTC.
Example : "2021-11-19T06:41:04Z"

string (date)

comment
optional
read-only

Comments for reviewer.
This field is only for media url.

string

relatedAdsCount
optional
read-only

The number of ads using this media url when this url has been rejected.
This field is only for readRejectedUrl API.

number

reviewStatus
optional
read-only

Review status of this entity.

enum (SKIPPED_REVIEW, IN_REVIEW, APPROVED, REJECTED)

review
optional

Review information.

Review

createdDate
optional
read-only

The created date in ISO 8601 format and in adaccount timezone.
Example : "2021-12-22T14:28:56+09:00"

string (date)

modifiedDate
optional
read-only

The last modified date in ISO 8601 format and in adaccount timezone.
Example : "2021-12-22T14:30:51+09:00"

string (date)

removedDate
optional
read-only

The removed date in ISO 8601 format and in adaccount timezone.
Example : "2021-12-22T19:39:03+09:00"

string (date)

7.17. ObsObject

obs related media information.

Name Description Schema

obsOid
optional
read-only

Id of this obs object

string

obsHash
optional
read-only

Hash code of this obs object.

string

fileName
optional
read-only

File name of this obs object.

string

sourceUrl
optional
read-only

The url of this obs object.

string

7.18. Review

Name Description Schema

reasonCode
optional
read-only

The reason code for rejection.

string

comment
optional
read-only

The comment of reviewer.

string

rejectReason
optional
read-only

The human-readable reason for rejection.

string

reReviewable
optional
read-only

A flag that shows whether re-review can be applied again after being rejected. This field is only for readRejectedUrl API.

boolean

7.19. AdgroupLearning

Name Description Schema

learningStatus
optional
read-only

The status of learning.

enum (LEARNING, NONE, DONE)

learningStatusCode
optional
read-only

The code of learning.

integer

lastLearningStartTs
optional
read-only

The start date of learning.
Example : 1569900000

integer

lastLearningEndTs
optional
read-only

The end date of learning.
Example : 1569900000

integer

targetReachRatio
optional
read-only

The percentage of progress.
Example : 0.3

number (double)

hasLearningCompletionHistory
optional
read-only

Whether learning has been completed in the past.

boolean

7.20. Targeting

Each targeting parameter is replaced with each one in a request when you call 'update' action.
※ GeoArea is not supported by ARS, so for Ad Groups with geoTargeting, all ARS requests will have a 422 response.

Name Description Schema

country
optional

The targeting country.
It must be the country of requesting adaccount.

enum (JP, TH, TW)

targetingMode
optional

The targeting mode of Adgroup.
Note that targeting mode AUTO restricts audience and advanced targeting.

enum (MANUAL, AUTO)

genders
optional

List of gender code.
See the Gender Codes API for the gender codes you can use.

< string > array

ageMin
optional

The lower limit of age in a range of age targeting.
See the Age Codes API for the lower ages you can use.

integer

ageMax
optional

The upper limit of age in a range of age targeting.
See the Age Codes API for the upper ages you can use.

integer

userOs
optional

List of OsVersion.

< OsVersion > array

customAudienceIds
optional

List of audience id for inclusion.

< string > array

excludedCustomAudienceIds
optional

List of audience id for exclusion.

< string > array

geoArea
optional

Geo targeting.

GeoArea

ssps
optional

List of placement network type.
See the Ssp Codes API for the ssp codes you can use.

< string > array

placements
optional

List of placement type.
See the Placement Codes API for the placement codes you can use.

< string > array

includeAdvancedTargetings
optional

List of Advanced Targetings which should be included.

< AdvancedTargeting > array

excludeAdvancedTargeting
optional

Advanced Targetings which should be excluded.

AdvancedTargeting

7.21. OsVersion

See the Os Codes API for the os codes and versions you can use.

Name Description Schema

os
required

The name of mobile operating system.

string

verMin
optional

The minimum version in a range of the operating system version.
Example : "10.0"

string

verMax
optional

The maximum version in a range of the operating system version.
Example : "10.1"

string

7.22. GeoArea

Geo targeting data.
The maximum number of include and exclude radius area is 5.

Name Description Schema

deliveryTargetingSetType
optional

The type of people targeted to deliver ads.
See the Geo Delivery Taget Codes API for the delivery targeting codes you can use.

string

includeAreas
optional

Locations that includes people for ad delivery.

< Area > array

excludeAreas
optional

Locations that excludes people for ad delivery.

< Area > array

7.23. Area

Location for targeting people.

Name Description Schema

areaType
required

The type of this area.
0 - Region type, the area is represented by area code.
1 - Radius type, the area is represented by latitude, longitude and radius.
Example : "0"

string

value
optional

The value representing location of area.
For region type, the value is an area code. (eg. 392.1)
For radius type, the value is a string of comma separated latitude and longitude. (eg. 36.589921,139.081554)
See the Area Codes API for the area codes you can use.

string

radius
optional

The radius of circular location which is centered at latitude and longitude, in kilometer.
This field is only for radius type.
Minimum value : 3
Maximum value : 50

integer

label
optional
read-only

Description of this location.

string

7.24. AdvancedTargeting

Advanced targeting data (Interest, Behavior, Status, Purchase intent, Yahoo! JAPAN Interest, Yahoo! JAPAN Purchase Intent, Yahoo! JAPAN Lifestyle.)
See the Advanced Targeting Codes API for the advanced targeting codes you can use.

Name Description Schema

interests
optional

List of User interest.

< string > array

behaviors
optional

List of User behavior.

< string > array

statuses
optional

List of User status.

< string > array

purchaseIntents
optional

List of User purchase intents.

< string > array

yjInterests
optional

List of Yahoo! Japan user interest.

< string > array

yjPurchaseIntents
optional

List of Yahoo! Japan user purchase intent.

< string > array

yjLifestyles
optional

List of Yahoo! Japan user lifestyle.

< string > array

7.25. Allowlist

Name Description Schema

id
optional

The id of LFP allowlist registered via ad manager

number

7.26. Ads

Name Schema

paging
optional
read-only

Paging

datas
optional
read-only

< Ad > array

7.27. Ad

If field is required and readOnly, it can be used and required in READ, DOWNLOAD operation, but can’t be used and not required in CREATE, UPDATE, DELETE operation.

Name Description Schema

id
required
read-only

Id of this ad.

number

adaccountId
optional

Id of adaccount as parent of ad.

string

adgroupId
required

Id of adgroup as parent of ad.

number

name
required

Name of this ad.
Length : 1 - 120

string

creative
required

Creative of this ad.
Creative can be modified only when configuredStatus is “DRAFT“.
When modifying, creative should be complete rather than containing only partial changes.

Creative

configuredStatus
optional

The status of this ad.
If the entity is removed, this status becomes “REMOVED”.
This status becomes “DRAFT“ if the entity is copied via ad manager, or if the ad is created with “DRAFT“ status.
This status cannot be changed to “DRAFT“ from another but only from “DRAFT“ to another.

enum (ACTIVE, PAUSED, DRAFT, REMOVED)

impTrackUrl
optional

The impression tracking URL of Nielsen, Flashtalking and Cinarra.
Accepted domains are limited to:
* '.imrworldwide.com' for Nielson
* '.flashtalking.com' for Flashtalking
* '*3ppa.jp.cinarra.com' for Cinarra
This url can be modified only when configuredStatus is “DRAFT“.
To remove url, set value to empty string(““).

string

viewTrackUrl
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', 'https://app.adjust.io' or 'https://impression.appsflyer.com'.
It can be used when
* bid type is CPM
* campaign objective is APP_INSTALL
* creative format is VIDEO
This url can be modified only when configuredStatus is “DRAFT“.
To remove url, set value to empty string(““).

string

smallDelivery
optional

Ad with CreativeFormat.VIDEO can be delivered to small inventory such as smart channel.
Video size should be 1by1 or 16by9.
It’s available only for adaccounts with smart channel enabled at this point.(TBU)
Default : false

boolean

generatedByAi
optional

Flag for checking the media is generated by AI.
* Only required in TW ads under non-DPA campaigns.

boolean

deliveryStatus
optional
read-only

The status of delivery ad.

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

deliveryStatusReasons
optional
read-only

The reason of delivery status.

< DeliveryStatusReason > array

createdDate
optional
read-only

The created date in ISO 8601 format and in adaccount timezone.
Example : "2021-12-22T14:28:56+09:00"

string (date)

modifiedDate
optional
read-only

The last modified date in ISO 8601 format and in adaccount timezone.
Example : "2021-12-22T14:30:51+09:00"

string (date)

removedDate
optional
read-only

The removed date in ISO 8601 format and in adaccount timezone.
Example : "2021-12-22T19:39:03+09:00"

string (date)

7.28. Creative

Name Description Schema

id
optional

Id of this creative.

number

creativeFormat
required

Type of creative format

enum (IMAGE, VIDEO, CAROUSEL, SMALL_IMAGE, SMALL_IMAGE_CPF, IMAGE_ANIMATION, IMAGE_ANIMATION_CPF, SMALL_VIDEO)

title
optional

The title of this creative.
This property is required if 'creativeFormat' is IMAGE, VIDEO, SMALL_IMAGE, SMALL_IMAGE_CPF, IMAGE_ANIMATION, IMAGE_ANIMATION_CPF, SMALL_VIDEO.

string

description
optional

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

string

longTitle
optional
read-only

The long title of this creative.
This property is required if 'creativeFormat' is SMALL_IMAGE, IMAGE_ANIMATION or SMALL_VIDEO.
This property is required if the image format of smallImageHash is 600x400.

string

imageHash
optional

Obs hash code of image media.
This property is required if 'creativeFormat' is IMAGE, SMALL_IMAGE, SMALL_IMAGE_CPF.

string

smallImageHash
optional

Obs hash code of small image media.
This property is optional if 'creativeFormat' is IMAGE.

string

videoHash
optional

Obs hash code of video media.
This property is required if 'creativeFormat' is VIDEO or SMALL_VIDEO.

string

animationHash
optional

Obs hash code of animation media.
This property is required if 'creativeFormat' is IMAGE_ANIMATION, IMAGE_ANIMATION_CPF.

string

callToAction
optional

Call to action and url object.

CallToAction

image
optional
read-only

Image media if this creative uses image.

Media

smallImage
optional
read-only

Small Image media if this creative uses small image.

Media

video
optional
read-only

Video media if this creative uses video.

Media

animation
optional
read-only

Animation media if this creative uses animation.

Media

slots
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

< CreativeSlot > array

labels
optional

Label string array.
This property is optional if 'creativeFormat' is not CAROUSEL.

< string > array

reviewStatus
optional
read-only

Review status of this entity.

enum (SKIPPED_REVIEW, IN_REVIEW, APPROVED, REJECTED)

review
optional

Review information.

Review

7.29. CallToAction

Name Description Schema

type
optional

The call to action code, which represents the label of action button.
See the Call To Actions API for the call to actions you can use.

string

landingPageUrl
optional

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

string

clickUrl
optional

The url for measuring performance of ad and tracking attributes.
If the viewTrackUrl is given, it is mandatory and must start with one of following url.
If viewTrackUrl starts with 'https://view.adjust.com', it should start with 'https://app.adjust.com'.
If viewTrackUrl starts with 'https://app.adjust.io', it should start with 'https://app.adjust.io'.
If viewTrackUrl starts with 'https://impression.appsflyer.com', it should start with 'https://app.appsflyer.com'.

string

appStoreUrl
optional

The url of the page for that app on store.

string

deepLinkUrl
optional

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

string

7.30. CreativeSlot

Name Description Schema

title
required

The title of this creative slot.

string

description
required

The description of this creative slot.

string

imageHash
optional

Obs hash code of image media.

string

videoHash
optional

Obs hash code of video media.

string

callToAction
optional

Call to action and url object.

CallToAction

image
optional
read-only

Image media if this creative uses image.

Media

smallImage
optional
read-only

Small Image media if this creative uses small image.

Media

video
optional
read-only

Video media if this creative uses video.

Media

animation
optional
read-only

Animation media if this creative uses animation.

Media

7.31. Medias

Name Schema

paging
optional
read-only

Paging

datas
optional
read-only

< Media > array

7.32. Reports

Name Schema

paging
optional
read-only

Paging

datas
optional
read-only

< Report > array

7.33. Report

Name Description Schema

id
optional

Id of this report.

number

name
optional
read-only

Name of this report.

string

status
optional
read-only

The status of report creation.

enum (CREATED, PREPARING, ERROR, READY)

queryParams
optional

Report query parameters.

ReportQueryParams

7.34. ReportQueryParams

Name Description Schema

level
required

The entity level of report.

enum (ADACCOUNT, CAMPAIGN, ADGROUP, AD)

since
optional

The start date to display statistics.
Default value is 3 months ago from today.
Pattern : "YYYY-MM-DD"
Example : "2021-12-21"

string

until
optional

The end date to display statistics.
Default value is today.
Pattern : "YYYY-MM-DD"
Example : "2021-12-22"

string

breakdown
optional

The report breakdown parameters.

ReportBreakdown

filtering
required

The report filtering parameters.

ReportFiltering

includeRemove
optional

Whether to include reports of removed entities.
Default : false

boolean

onlyCarouselSlot
optional

This is deprecated. Please use 'CAROUSEL' for ReportBreakdown’s 'specific' property.
A boolean flag that the report includes only the carousel ads report.
It can be set to true only when 'level' is AD.
Default : false

boolean

fileFormat
required

The report file format.

enum (CSV, CSV_EXCEL)

locale
optional

The report locale.

enum (ja, th, zh_TW, en)

7.35. ReportBreakdown

Name Description Schema

delivery
optional

The unit of delivery segment for collecting report.

enum (os, gender, age, area, interest, behavior, status, purchase_intent)

time
optional

Time unit for collecting report.

enum (DAY)

byServiceGroup
optional

A boolean flag that separating report by placement type.
It can not be set to true when 'level' is AD.
It can be set to true only in JP, TW adaccount.

boolean

specific
optional

The specific type of report.
'CAROUSEL' and 'IMAGE_SIZE' can be set only when 'level' is AD.

enum (CAROUSEL, IMAGE_SIZE)

7.36. ReportFiltering

Name Description Schema

idType
optional

The type of id for filtering.

enum (ADACCOUNT)

ids
optional

The ids for filtering.
For 'idType' ADACCOUNT, it must be list of single adaccount id in your request path.

< string > array

7.37. ReportOnlineResponse

Name Schema

paging
optional
read-only

Paging

datas
optional
read-only

< ReportOnlineDto > array

timeRange
optional

TimeRange

7.38. ReportOnlineDto

Name Description Schema

adaccount
optional
read-only

Simple adaccount information that may include partial information.

Adaccount

campaign
optional
read-only

Simple campaign information that may include partial information.

Campaign

adgroup
optional
read-only

Simple adgroup information that may include partial information.

Adgroup

ad
optional
read-only

Simple ad information that may include partial information.

Ad

statistics
optional
read-only

Statistics information.

ReportOnlineStatistics

7.39. ReportOnlineStatistics

Note
 SKAdNetwork-specific fields are only available in SKAdNetwork-enabled ad groups in ad accounts that have the SKAdNetwork feature enabled.
Name Description Schema

currency
optional

The currency of statistics.

string

cost
optional

Cost

number

imp
optional

Impression

number

viewableImp
optional

Viewable impression

number

click
optional

Clicks

number

cv
optional

Conversions

number

cvApi
optional

CV API

number

cvWithCvApi
optional

Conversions + CV API

number

cvWithCvApiWithEv
optional

Conversions + CV API + Engagement View Conversions

number

videoCompletions
optional

Video 100% watched

number

videoStart
optional

Video play start

number

videoView3s
optional

Video watched for at least 3 seconds (JP only)

number

videoView25r
optional

Video 25% watched (JP only)

number

videoView50r
optional

Video 50% watched (JP only)

number

videoView75r
optional

Video 75% watched (JP only)

number

videoView95r
optional

Video 95% watched (JP only)

number

reach
optional

Reach of reach. This field is nullable.

number

ctr
optional

CTR

number

cvr
optional

CVR

number

cpc
optional

CPC

number

cpm
optional

CPM

number

cpa
optional

CPA

number

cvWithCvApiCvr
optional

The number of CVR in cvWithCvApi

number

cvWithCvApiCpa
optional

The number of CPA in cvWithCvApi

number

cvWithCvApiCvrWithEv
optional

The number of CVR in cvWithCvApiWithEv

number

cvWithCvApiCpaWithEv
optional

The number of CPA in cvWithCvApiWithEv

number

cvViewItemDetailWithEv
optional

The number of "conversion View item detail (ALL)" event

number

cvrViewItemDetailWithEv
optional

The number of CVR in cvViewItemDetailWithEv

number

cpaViewItemDetailWithEv
optional

The number of CPA in cvViewItemDetailWithEv

number

cvViewItemDetail
optional

The number of "conversion View item detail" event

number

cvrViewItemDetail
optional

The number of CVR in cvViewItemDetail

number

cpaViewItemDetail
optional

The number of CPA in cvViewItemDetail

number

cvAddToCartWithEv
optional

The number of "conversion Add To Cart (ALL)" event

number

cvrAddToCartWithEv
optional

The number of CVR in cvAddToCartWithEv

number

cpaAddToCartWithEv
optional

The number of CPA in cvAddToCartWithEv

number

cvAddToCart
optional

The number of "conversion Add To Cart" event

number

cvrAddToCart
optional

The number of CVR in cvAddToCart

number

cpaAddToCart
optional

The number of CPA in cvAddToCart

number

cvInitiateCheckOutWithEv
optional

The number of "conversion Initiate Check Out (ALL)" event

number

cvrInitiateCheckOutWithEv
optional

The number of CVR in cvInitiateCheckOutWithEv

number

cpaInitiateCheckOutWithEv
optional

The number of CPA in cvInitiateCheckOutWithEv

number

cvInitiateCheckOut
optional

The number of "conversion Initiate Check Out" event

number

cvrInitiateCheckOut
optional

The number of CVR in cvInitiateCheckOut

number

cpaInitiateCheckOut
optional

The number of CPA in cvInitiateCheckOut

number

cvPurchaseWithEv
optional

The number of "conversion Purchase (ALL)" event

number

cvrPurchaseWithEv
optional

The number of CVR in cvPurchaseWithEv

number

cpaPurchaseWithEv
optional

The number of CPA in cvPurchaseWithEv

number

cvPurchase
optional

The number of "conversion Purchase" event

number

cvrPurchase
optional

The number of CVR in cvPurchase

number

cpaPurchase
optional

The number of CPA in cvPurchase

number

cvPurchaseValue
optional

The value of "Conversion Purchase (Clicks)" event

number

cvPurchaseValueWithEv
optional

The value of "Conversion Purchase (ALL)" event

number

ROAS
optional

Return on ads spend for purchase event (Clicks)

number

ROASWithEv
optional

Return on ads spend for purchase event (All)

number

cvGenerateLeadWithEv
optional

The number of "conversion Generate lead (ALL)" event

number

cvrGenerateLeadWithEv
optional

The number of CVR in cvGenerateLeadWithEv

number

cpaGenerateLeadWithEv
optional

The number of CPA in cvGenerateLeadWithEv

number

cvGenerateLead
optional

The number of "conversion Generate lead" event

number

cvrGenerateLead
optional

The number of CVR in cvGenerateLead

number

cpaGenerateLead
optional

The number of CPA in cvGenerateLead

number

cvCompleteReservationWithEv
optional

The number of "conversion Complete Reservation (ALL)" event

number

cvrCompleteReservationWithEv
optional

The number of CVR in cvCompleteReservationWithEv

number

cpaCompleteReservationWithEv
optional

The number of CPA in cvCompleteReservationWithEv

number

cvCompleteReservation
optional

The number of "conversion Complete Reservation" event

number

cvrCompleteReservation
optional

The number of CVR in cvCompleteReservation

number

cpaCompleteReservation
optional

The number of CPA in cvCompleteReservation

number

cvCompleteRegistrationWithEv
optional

The number of "conversion Complete Registration (ALL)" event

number

cvrCompleteRegistrationWithEv
optional

The number of CVR in cvCompleteRegistrationWithEv

number

cpaCompleteRegistrationWithEv
optional

The number of CPA in cvCompleteRegistrationWithEv

number

cvCompleteRegistration
optional

The number of "conversion Complete Registration" event

number

cvrCompleteRegistration
optional

The number of CVR in cvCompleteRegistration

number

cpaCompleteRegistration
optional

The number of CPA in cvCompleteRegistration

number

costPerVideoView3s
optional

Cost per 3sec views

number

costPerVideoCompletion
optional

Cost per Complete views

number

install
optional

Install count(click)

number

vtInstall
optional

Install count(view) (JP only)

number

totalInstall
optional

Install count(click+view) (JP only)

number

totalInstallWithEv
optional

Install count(click+view+evcv) (JP only)

number

skadnInstall
optional

Install count measured by SKAdNetwork.

number

openWithEv
optional

Open count with engagement view conversion

number

open
optional

Open count

number

viewHomeWithEv
optional

The number of viewing home with engagement view conversion

number

viewHome
optional

The number of viewing home

number

viewCategoryWithEv
optional

The number of viewing category with engagement view conversion

number

viewCategory
optional

The number of viewing category

number

viewItemWithEv
optional

The number of viewing item with engagement view conversion

number

viewItem
optional

The number of viewing item

number

searchWithEv
optional

Search count with engagement view conversion

number

search
optional

Search count

number

addToCartWithEv
optional

The number of adding cart with engagement view conversion

number

addToCart
optional

The number of adding cart

number

purchaseWithEv
optional

Purchasing count with engagement view conversion

number

purchase
optional

Purchasing count

number

levelAchievedWithEv
optional

Level achieving count with engagement view conversion

number

levelAchieved
optional

Level achieving count

number

tutorialCompleteWithEv
optional

Tutorial completion count with engagement view conversion

number

tutorialComplete
optional

Tutorial completion count

number

totalInstallCvrWithEv
optional

Install CVR with engagement view conversion

number

installCvr
optional

Install CVR

number

skadnInstallCvr
optional

Install CVR measured by SKAdNetwork.

number

installCpa
optional

Install CPA(click)

number

totalInstallCpaWithEv
optional

Install CPA(click+view+evcv) (JP only)

number

totalInstallCpa
optional

Install CPA(click+view) (JP only)

number

skadnInstallCpa
optional

Install CPA measured by SKAdNetwork.

number

openCvrWithEv
optional

Open (ALL) CTR

number

openCpaWithEv
optional

Open (ALL) CPA

number

openCvr
optional

Open CTR

number

openCpa
optional

Open CPA

number

viewHomeCvrWithEv
optional

View home (ALL) CVR

number

viewHomeCpaWithEv
optional

View home (ALL) CPA

number

viewHomeCvr
optional

View home CVR

number

viewHomeCpa
optional

View home CPA

number

viewCategoryCvrWithEv
optional

View category (ALL) CVR

number

viewCategoryCpaWithEv
optional

View category (ALL) CPA

number

viewCategoryCvr
optional

View category CVR

number

viewCategoryCpa
optional

View category CPA

number

viewItemCvrWithEv
optional

View item (ALL) CVR

number

viewItemCpaWithEv
optional

View item (ALL) CPA

number

viewItemCvr
optional

View item CVR

number

viewItemCpa
optional

View item CPA

number

searchCvrWithEv
optional

Search (ALL) CVR

number

searchCpaWithEv
optional

Search (ALL) CPA

number

searchCvr
optional

Search CVR

number

searchCpa
optional

Search CPA

number

addToCartCvrWithEv
optional

Add-to-cart (ALL) CVR

number

addToCartCpaWithEv
optional

Add-to-cart (ALL) CPA

number

addToCartCvr
optional

Add-to-cart CVR

number

addToCartCpa
optional

Add-to-cart CPA

number

purchaseCvrWithEv
optional

Purchase (ALL) CVR

number

purchaseCpaWithEv
optional

Purchase (ALL) CPA

number

purchaseCvr
optional

Purchase CVR

number

purchaseCpa
optional

Purchase CPA

number

levelAchievedCpaWithEv
optional

Level achieved (ALL) CTR

number

levelAchievedCvrWithEv
optional

Level achieved (ALL) CVR

number

levelAchievedCpa
optional

Level achieved CTR

number

levelAchievedCvr
optional

Level achieved CVR

number

tutorialCompleteCvrWithEv
optional

Tutorial complete (ALL) CVR

number

tutorialCompleteCpaWithEv
optional

Tutorial complete (ALL) CPA

number

tutorialCompleteCvr
optional

Tutorial complete CVR

number

tutorialCompleteCpa
optional

Tutorial complete CPA

number

impShareRate
optional

The percentage of ads actually shown to users out of all display opportunities. Display only in adgroup.

number

lostImpShareByBudgetRate
optional

The percentage of ads that couldn’t be shown to users due to insufficient budget out of all display opportunities. Display only in adgroup.

number

lostImpShareByRankRate
optional

The percentage of ads that couldn’t be shown to users due to a low auction rank out of all display opportunities. Display only in adgroup.

number

recommendedBudgetMicro
optional

Estimated lowest budget amount at which the campaign or the adgroup wouldn’t lose any bidding opportunities due to budget constraints.
Represented in micros and in the local currency of the account. Display in campaign and adgroup.

number

7.40. TimeRange

Name Description Schema

since
optional
read-only

The start date to display data.
Pattern : "YYYY-MM-DD"
Example : "2021-12-21"

string

until
optional
read-only

The end date to display data.
Pattern : "YYYY-MM-DD"
Example : "2021-12-22"

string

7.41. ArsSimulationRequest

Name Description Schema

adaccountId
required

Id of the adaccount.

string

campaignId
required

Id of the campaign.

number

adgroupId
optional

Id of the adgroup.

number

campaignObjective
required

The objective of this campaign.

enum (VISIT_MY_WEBSITE, APP_INSTALL, APP_ENGAGEMENT, WEBSITE_CONVERSION, DYNAMIC_PRODUCT, GAIN_FRIENDS, VIDEO_VIEW)

dailyBudgetMicro
required

Daily budget in micros in adaccount currency.
Example : 120000000000

integer (int64)

bidAmountMicro
optional

Bid Amount in micros and in adaccount currency.
Example : 100000000

integer (int64)

bidType
required

The type of bid.

enum (CPC, CPF, CPM)

bidStrategy
optional

The type of bidStrategy. If autoBidType is manual, bidStrategy is null.

enum (LOWEST_COST, COST_CAP, TARGET_COST, TARGET_ROAS)

autoBidType
required

The type of auto bidding.

enum (MANUAL, CLICK, CONVERSION, CUSTOM_CONVERSION, STANDARD_CV_PURCHASE, CV_INSTALL, CV_OPEN, FRIEND, VIDEO_VIEW_3S, VIDEO_VIEW_COMPLETION, REACH, CV_SKADNETWORK, CV_LEAD, CV_VALUE_STANDARD_PURCHASE)

targeting
required

Targeting

7.42. ArsSimulationResult

Name Description Schema

uuid
optional

Id of simulation result.

string

reach
optional

The min and max of reach.

< integer > array

resultEventId
optional

Id of event.

string

result
optional

The min and max of click.

< integer > array

ignoredFields
optional

ignored fields list.

object

absentFields
optional

required fields list.

< object > array

invalidFields
optional

invalid fields list.

object

7.43. Code

Name Description Schema

code
optional
read-only

The code used in request.

string

type
optional
read-only

The type of this code.

string

name
optional
read-only

The human-readable code name.

string

7.44. AgeCode

Name Description Schema

code
optional
read-only

The age code.

string

upper
optional

the upper limit of this age code, which is used in request.

integer

lower
optional

the lower limit of this age code, which is used in request.

integer

7.45. OsCode

Name Description Schema

code
optional
read-only

The code used in request.

string

type
optional
read-only

The type of this code.

string

name
optional
read-only

The human-readable code name.

string

versions
optional

Available versions of this os code.

< string > array

7.46. AreaCode

Name Description Schema

code
optional
read-only

The code used in request.

string

name
optional
read-only

The human-readable code name.

string

children
optional
read-only

The list of child areas.
The children is optional.

< AreaCode > array

7.47. AdvancedTargetingCodes

A tree structure of all available advanced targeting codes.

Name Description Schema

interests
optional
read-only

List of Interest codes.

< AdvancedTargetingCode > array

behaviors
optional
read-only

List of User behavior codes.

< AdvancedTargetingCode > array

statuses
optional
read-only

List of User status codes.

< AdvancedTargetingCode > array

purchaseIntents
optional
read-only

List of User purchase intent codes.

< AdvancedTargetingCode > array

yjInterests
optional
read-only

List of Yahoo! Japan user interest codes.
Only JP is supported.

< AdvancedTargetingCode > array

yjPurchaseIntents
optional
read-only

List of Yahoo! Japan user purchase intent codes.
Only JP is supported.

< AdvancedTargetingCode > array

yjLifestyles
optional
read-only

List of Yahoo! Japan user lifestyle codes.
Only JP is supported.

< AdvancedTargetingCode > array

7.48. AdvancedTargetingCode

A node of tree that respresents a advanced targeting code.

Name Description Schema

code
optional
read-only

The code used in request.

string

type
optional
read-only

The type of this code.

string

name
optional
read-only

The human-readable code name.

string

description
optional
read-only

The description of the code.

string

audienceSize
optional
read-only

The audience size of targeting.
Value -1 means it is not available.

number

betaFlag
optional
read-only

Indicates whether the code is beta.

boolean

selectable
optional
read-only

Indicates whether the code can actually be used for targeting.
If true, the code is segment and can be used for targeting.
If false, the code is category and can not be used for targeting.

boolean

children
optional
read-only

The child nodes.

< AdvancedTargetingCode > array

8. Delivery Status Reasons

name description

REMOVED

Removed

CREATIVE_REVIEW_NOT_APPROVED

Ad not approved

AD_BLOCKED

Ad blocked

CREATIVE_BLOCKED

Creative blocked

CREATIVE_REVIEW_IN_REVIEW

Ad in review

AD_DRAFT

Ad drafted

VIDEO_ENCODING_FAILED

Video Encoding failed

DPA_SETTING_INVALID

Dynamic ads cannot be served because an error has occurred. If the error persists for more than one hour, Please check if the LINE Tag is set correctly or if the data in the tag and feed match.

ADGROUP_APP_REVIEW_NOT_APPROVED

App not approved

ADGROUP_BLOCKED

Ad group blocked

ADGROUP_APP_REVIEW_IN_REVIEW

App in review

ADGROUP_INVALID_TARGETING

Ad group with invalid targeting

ADGROUP_BEACON_TARGETING_CATEGORY_NOT_ACTIVE

Beacon targeting category is not active

ADGROUP_BEACON_TARGETING_NO_CHAIN_ACTIVE

Beacon targeting does not have any active chain

ADGROUP_BEACON_TARGETING_ALL_TAG_NOT_ACTIVE

Beacon targeting all tag is not active

ALL_AUDIENCE_NOT_ACTIVE

All include audiences are not active

EXCLUDE_AUDIENCE_NOT_ACTIVE

One of exclude audiences have invalid state

ADGROUP_FREQUENCY_SCHEDULED

Before ad group frequency period

ADGROUP_FREQUENCY_ENDED

After ad group frequency period

PRODUCTSET_DELETED

The product set setup to this ad group has been deleted

PRODUCTSET_INACTIVE

The product set needs more than 2 feed items. Change the conditions for creating the product set

PRODUCTSET_NOTSET

Product set is not set to ad group.

CAMPAIGN_BLOCKED

Campaign blocked

CAMPAIGN_SCHEDULED

Campaign scheduled

CAMPAIGN_ENDED

Campaign ended

CAMPAIGN_SPENDING_LIMIT_OVER

Campaign limited by budget

CAMPAIGN_DPA_FEED_NO_PRODUCT

Product feed is no products

CAMPAIGN_DPA_FEED_INVALID

Product feed is invalid

CAMPAIGN_CPF_NOT_VERIFIED

Unverified LINE Official accounts cannot run gain friends campaigns

CAMPAIGN_CANNOT_MANAGE_LINE_POP

Ad account cannot manage line pop campaign

BILLING_REVIEW_NOT_APPROVED

Billing not approved

BILLING_REVIEW_IN_REVIEW

Billing in review

BILLING_NOT_LINKED

Billing Not linked

BILLING_NO_CREDIT_CARD

Billing no credit card

BILLING_REACHED_MONTHLY_LIMIT

Billing reached monthly limit

BILLING_AUTO_PAYMENT_SUSPENDED

Billing auto payment suspended

ADACCOUNT_REVIEW_NOT_APPROVED

Ad account not approved

ADACCOUNT_BLOCKED

Ad account blocked

ADACCOUNT_REVIEW_IN_REVIEW

Ad account in review

LINE_ACCOUNT_LINK_NOT_APPROVED

LINE account link not approved

LINE_ACCOUNT_NOT_EXIST

LINE account not exist

LINE_ACCOUNT_STATUS_DELETED

LINE Account deleted

LINE_ACCOUNT_STATUS_IN_ACTIVE

LINE Account inactive

LINE_ACCOUNT_STATUS_SUSPENDED

LINE Account suspended

AD_PAUSED

Ad paused

ADGROUP_PAUSED

Adgroup paused

CAMPAIGN_PAUSED

Campaign paused

ADACCOUNT_PAUSED

Ad account paused

ACTIVE_ADGROUP_LEARNING

Adgroup learning

ACTIVE_ADGROUP_LEARNING_DONE

Adgroup learning done

ACTIVE_CUSTOM_CONVERSION_UNAVAILABLE

Custom conversion unavailable

ACTIVE_CUSTOM_CONVERSION_NEW

Custom conversion new

AD_TEXTAREA_PENALTY

Ad textarea penalty

ACTIVE_ADGROUP_BEACON_TARGETING_SOME_CHAIN_NOT_ACTIVE

Beacon targeting some chains are not active

ACTIVE_ADGROUP_BEACON_TARGETING_SOME_TAG_NOT_ACTIVE

Beacon targeting some chains are not active

ACTIVE

Active

9. Error Reasons

name description

ACCESSIBLE_ACCOUNT_LIMIT_EXCEEDED

the number of account link exceed limit

ACCOUNT_FRIENDS_AUDIENCE_GROUP_ALREADY_EXISTS

same firend audience is already exist

ACCOUNT_NOT_ALLOWED

the account is not allowed to use the feature

ACTIVE_AD_IN_ADGROUP_COUNT_OVER

the number of active ad in adgroup exceed limit

ADACCOUNT_ALREADY_EXIST_IN_GROUP_TREE

account already exist in group tree

ADACCOUNT_CANNOT_MANAGE_DPA

managing dpa conversion is not allowed

ADACCOUNT_CANNOT_MANAGE_IN_STREAM_VIDEO

managing in-stream video adgroup is not allowed

ADACCOUNT_CANNOT_MANAGE_RNF

managing R&F conversion is not allowed

ADACCOUNT_CANNOT_MANAGE_WEBSITE_CONVERSION

managing website conversion is not allowed

ADACCOUNT_LINKED_TOO_MANY_GROUP

the number of account-group link exceed limit

ADGROUP_APP_INSTALL_EVENT_NOT_YET

app install event is not captured yet

ADGROUP_INVALID_AUDIENCE_SETTING

the audience setting of adgroup is invalid

ADGROUP_IN_ADACCOUNT_COUNT_OVER

the number of adgroup count exceed limit

ADGROUP_IN_CAMPAIGN_COUNT_OVER

the number of adgroup in campaign exceed limit

ADGROUP_IN_STREAM_VIDEO_AUTO_BIDDING_NOT_ALLOWED

in-stream type adgroup is not allowed for given campaign objective

ADGROUP_IN_STREAM_VIDEO_CAMPAIGN_OBJECTIVE_NOT_ALLOWED

in-stream type adgroup is not allowed for given campaign objective

ADGROUP_IN_STREAM_VIDEO_COUNTRY_NOT_ALLOWED

in-stream type adgroup is not allowed for given adaccount country

ADGROUP_LINE_POP_BID_AMOUNT_MUST_BE_CATEGORY_FIXED_CPM

Adgroup bid amount of line pop campaign must be fixed CPM of category in beacon targeting

ADGROUP_LINE_POP_UPDATING_BID_AMOUNT_NOT_ALLOWED

Updating bidAmount in line pop campaign is not allowed

ADGROUP_NAME_DUPLICATED

adgroup name is duplicated

ADGROUP_REQUIRE_RNF_FIELDS

all R&F fields in the adgroup is required

ADGROUP_RNF_FIELDS_NOT_ALLOWED

R&F field in the is not allowed

ADGROUP_RNF_OUT_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

pdating 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_BUTTON_CAMPAIGN_OBJECTIVE_NOT_AVAILABLE

Call to action is not available for the campaign objective

AD_CAMPAIGN_OBJECTIVE_NOT_AVAILABLE

The creative format is not available for the campaign objective

AD_CANNOT_HAVE_DESCRIPTION

Ad cannot have description

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_DESCRIPTION_REQUIRED

Ad description is required

AD_GAIN_FRIENDS_CAMPAIGN_MUST_BE_IMAGE

unsupported media type for gain friend campaign

AD_IMP_TRACK_URL_SUPPORT_REACH_AND_FREQUENCY

Impression tracking URL is supported for REACH_AND_FREQUENCY campaign objective

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_PARENT

Cannot create ad for deleted parent entity

AD_INVALID_VIEW_TRACK_DOMAIN

View track URL’s domain must be start with https://view.adjust.com

AD_IN_ADACCOUNT_COUNT_OVER

the number of ad in account exceed limit

AD_IN_ADGROUP_COUNT_OVER

the number of ad in adgroup exceed limit

AD_LONG_TITLE_ONLY_USE_SMALL_IMAGE

Long title fields must be small image ad

AD_NAME_DUPLICATED

ad name is duplicated

AD_SMALL_IMAGE_MUST_BE_IMAGE_600_400

Small image ad must be image format(600x400)

AD_SMALL_IMAGE_MUST_INCLUDE_LONG_TITLE

Small image ad must include the long title

AD_TITLE_REQUIRED

Ad title is required

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

APP_EVENT_AUDIENCE_GROUP_ACTION_TYPE_NOT_EXISTS

app event type cannot be used

APP_EVENT_AUDIENCE_GROUP_INVALID_COMBINATION_ACTION_TYPE_AND_PARAMETER

invalid conbination of event type and parameter

APP_EVENT_AUDIENCE_GROUP_INVALID_COMBINATION_PARAMETER_AND_CONDITION

invalid combination of parameter and condition

APP_EVENT_AUDIENCE_GROUP_INVALID_CONDITION

field has invalid format

APP_EVENT_AUDIENCE_GROUP_MAX_LENGTH_OVER_APP_EVENT_CONDITION_GROUP_KEYWORD

keyword is out of range

APP_EVENT_AUDIENCE_GROUP_MISSING_CONDITION_GROUP

required field is not set

APP_EVENT_AUDIENCE_GROUP_MISSING_CONDITION_GROUP_VALUES

required field is not set

APP_EVENT_AUDIENCE_GROUP_TOO_MANY_APP_EVENT_CONDITION_GROUP_VALUES

the number of values exceed limit

APP_IN_ADACCOUNT_COUNT_OVER

You can only add one app per OS.

AUDIENCE_GROUPS_CAN_NOT_DELETE_REFFERED_LOOKALIKE_AUDIENCE_GROUP_STILL_EXISTS

the audience that you want to remove is in using state

AUDIENCE_GROUP_COUNT_MAX_OVER

the number of audience in group exceed limit

AUDIENCE_GROUP_NAME_DUPLICATE

custom audience name is duplicated

AUDIENCE_GROUP_NAME_EMPTY

audience group name is empty

AUDIENCE_GROUP_NAME_SIZE_OVER

field is out of range

AUDIENCE_GROUP_NAME_WRONG

field has invalid format

AUDIENCE_GROUP_NOT_FOUND

id is invalid

AUTHORIZATION_FAILED

authorization failed

AUTO_BID_NOT_ALLOWED

the campaign objective is not allowed auto bid type

BID_AMOUNT_IS_NOT_NULL

Bid amount is not null in given bid strategy

BID_AMOUNT_IS_NULL

Bid amount is null in given auto bid type & bid strategy

BID_AMOUNT_OUT_OF_RANGE

field is out of range

BID_TYPE_NOT_ALLOWED

the campaign objective is not allowed the bid type

BLOCKED_BY_EXCEEDING_TIME_LIMIT

operation time exceed lock timeout limit

BLOCK_APP_CANNOT_ACQUIRE_LOCK

operation time exceed lock timeout limit

CAMPAIGN_IN_ADACCOUNT_COUNT_OVER

the number of campaign count exceed limit

CAMPAIGN_NAME_DUPLICATED

campaign name is duplicated

CAMPAIGN_START_END_DATE

tart date is later than end date

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_SET_FIELD

field cannot be set

CANNOT_SPECIFY_DELIVERY_TYPE_ON_AD_REPORT

cannot specify delivery type

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

CONDITION_OF_CUSTOM_CONVERSION_IS_NOT_SATISFIED

the custom conversion id does not satisfy conditions for to be usable id

COPY_FAILED_WITH_LOCK

operation time exceed lock timeout limit

COST_SCALE_ERROR

currency is not allow multiple unit

CUSTOM_CONVERSION_AUTO_BIDDING_MUST_HAVE_CUSTOM_CONVERSION_ID

custom conversion adgroup must have a custom conversion id

CUSTOM_CONVERSION_COUNT_MAX_OVER

the number of audience group exceed limit

CUSTOM_CONVERSION_CUSTOM_EVENT_NAME_NOT_EXISTS

event name is not exist

CUSTOM_CONVERSION_DESCRIPTION_SIZE_OVER

field is out of range

CUSTOM_CONVERSION_DESCRIPTION_WRONG

field has invalid format

CUSTOM_CONVERSION_MAX_LENGTH_OVER_URL_CONDITION_GROUP_KEYWORDS

keyword legnth is out of range

CUSTOM_CONVERSION_MISSING_CONVERSION_EVENT_NAME

required field is not set

CUSTOM_CONVERSION_MISSING_URL_CONDITION_GROUP

required field is not set

CUSTOM_CONVERSION_MISSING_URL_CONDITION_GROUP_KEYWORDS

required field is not set

CUSTOM_CONVERSION_NAME_DUPLICATE

custom conversion name is duplicated

CUSTOM_CONVERSION_NAME_SIZE_OVER

field is out of range

CUSTOM_CONVERSION_NAME_WRONG

field has invalid format

CUSTOM_CONVERSION_NOT_FOUND

id is invalid

CUSTOM_CONVERSION_SAME_URL_CONDITION_GROUP_KEYWORDS

keyword is duplicated

CUSTOM_CONVERSION_TOO_MANY_URL_CONDITION_GROUP_KEYWORDS

the number of keyword exceed limit

CUSTOM_CONVERSION_UNNECESSARY_CONVERSION_EVENT_NAME

field cannot be set

CUSTOM_CONVERSION_WRONG_URL_CONDITION_GROUP_KEYWORDS

field has invalid format

DAILY_BUDGET_IS_LESS_THAN_BID_AMOUNT

the daily budget amount is must be not less than bid micro amount

DECODING_FAILED

failed to decode input stream

DPA_CAMPAIGN_IN_ADACCOUNT_COUNT_OVER

the number of dpa campaign count exceed limit

DPA_CAMPAIGN_NO_FEED_SETTING

dpa feed is not set

DUPLICATE_KEY

field has duplicated key

DURATION_LIMIT_EXCEEDED

duration exceed limit

DURATION_TOO_SHORT

duration too short

EMPTY_FILE

file is empty

ENTITY_NOT_FOUND_INVALID_ID

id is invalid

FILE_SIZE_LIMIT_EXCEEDED

file exceed limit size

GROUP_ALREADY_HAS_SAME_ADACCOUNT_LINK

group already has same account link

GROUP_ALREADY_REQUESTED_SAME_ADACCOUNT

group already requested same account

GROUP_HAS_TOO_MANY_ADACCOUNT

the group has too many linked account

GROUP_HAS_TOO_MANY_CHILDREN

the number of group-group link exceed the limit

GROUP_HAS_TOO_MANY_DEPTH

the group has to many ancestor groups

GROUP_LINK_REQUEST_TARGET_ADACCOUNT_DOES_NOT_EXIST

id is invalid

HISTORY_DOWNLOAD_NOT_READY

The status is not ready for downloading

HISTORY_INVALID_FILE_FORMAT

The file format is invalid

HISTORY_INVALID_ID

Given id is invalid

IMAGE_IN_ADACCOUNT_COUNT_OVER

the number of image in account exceed limit

INVALID_ACCOUNT_ID

invalid account id

INVALID_ANIMATION

invalid animation

INVALID_ASPECT_RATIO

invalid aspect ratio

INVALID_CAMPAIGN_ID

invalid campaign id

INVALID_CONTENT_TYPE_HEADER

content type header is invalid

INVALID_DATE_FORMAT

field has invalid date format

INVALID_ENUM

field has invalid enum

INVALID_FILE_CONTENT

file has invalid content

INVALID_FORMAT

the value format is invalid

INVALID_GROUP_ID

invalid group id

INVALID_IMAGE_SIZE

invalid image size

INVALID_MEDIA_TYPE

invalid media type

INVALID_NUMBER_FORMAT

field has invalid number format

INVALID_REQUEST

the request input is invalid

INVALID_SIZE

array size is invalid

INVALID_UNIQUE_ELEMENTS

must only contain unique elements

INVALID_VALUE

the value is invalid

LOCK_DEFAULT

operation time exceed lock timeout limit

LOOKALIKE_AUDIENCE_GROUP_COUNT_MAX_OVER

the number of audience group exceed limit

LOOKALIKE_DUPLICATE_AUDIENCE_GROUP

same lookalike audience is exist

LOOKALIKE_SOURCE_AUDIENCE_GROUP_INSUFFICIENT

source audience insufficient

LOOKALIKE_SOURCE_AUDIENCE_GROUP_NOT_FOUND

id is invalid

LOOKALIKE_SOURCE_AUDIENCE_GROUP_TOO_MUCH

source audience group contain too much audienceCount

MANUAL_BID_NOT_ALLOWED

the campaign objective is not allowed manual bid type

MEDIA_9_16_VIDEO_USED_NOT_IN_RNF

9:16 media is not allowed except R&F

MEDIA_APP_NOT_NEEDED

media app doesn’t be needed given campaign objective

MEDIA_APP_USING_AUDIENCE

media app is using audience

MEDIA_APP_USING_IN_ACTIVE_ADGROUP

media app using in active adgroup

MEDIA_PIXEL_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

ONLY_FIRST_ID_CAN_USE_IN_CUSTOM_CONVERSION_AUTOBID

custom conversion autobid can only use same conversion id as the first

OUT_OF_RANGE

field is out of range

PARTNER_PERMISSION_DENIED

partner permission denied

REMOVED_ENTITY

entity already removed

REQUEST_ILLEGAL_ARGUMENT

there is illegal argument

REQUEST_INPUT_ADACCOUNT_ID_INVALID

id is invalid

REQUEST_INPUT_AGE_MIN_MAX_REVERSED

min age is bigger than max age

REQUEST_INPUT_DATE_MUST_BE_FUTURE

date must not be past

REQUEST_INPUT_FORMAT_INVALID

field has invalid format

REQUEST_INPUT_FUTURE

date must not be future

REQUEST_INPUT_INCLUDE_AND_EXCLUDE_CONTAINS_SAME_AUDIENCE

include audiences and exclude audiences are conflict

REQUEST_INPUT_INVALID

field cannot be set

REQUEST_INPUT_NOT_NULL_APP

media app cannot be null

REQUEST_INPUT_OS_VERSION_INVALID

min os version and max os version must be predefined values

REQUEST_INPUT_OS_VERSION_REVERSED

min os version is bigger than max os version

REQUEST_INPUT_PAST

date must not be past

REQUEST_INPUT_PERIOD_LONGER_THAN_ONE_MONTH

request period cannot be longer than a month

REQUEST_INPUT_REQUIRED

required field is not set

REQUEST_INPUT_SIZE

field is out of range

REQUEST_INPUT_START_DATE_TOO_PAST

start date is too past

REQUEST_INPUT_START_END_DATE_REVERSED

start date is later than end date

REQUEST_INPUT_TOO_HIGH

filed is too high

REQUEST_INPUT_TOO_LOW

field is too low

REQUIRED

required field is not set

REQUIRED_REQUEST_BODY

request body is required

RESOURCE_ID_DUPLICATE

resourceId duplicate

TARGETING_BEACON_TARGETING_INCLUDES_MORE_THAN_ONE_CATEGORY

Chains in beacon targeting belong to more than one category

TARGETING_BEACON_TARGETING_INCLUDES_NON_CHAIN_PLACEMENTS

Beacon targeting include placements which is not a chain

TARGETING_BEACON_TARGETING_INCLUDES_NOT_ACTIVE_PLACEMENTS

Beacon targeting cannot include not active placements

TARGETING_BEACON_TARGETING_INCLUDES_NOT_ACTIVE_TAGS

Beacon targeting cannot include not active tags

TARGETING_BEACON_TARGETING_NEEDED

Line pop adgroup must have beacon targeting

TARGETING_CODE_IS_NOT_AVAILABLE_IN_CAMPAIGN_OBJECTIVE

There are some targeting codes that cannot be used in the campaign objective

TARGETING_GAIN_FRIENDS_NO_EXCLUDE_FRIEND_AUDIENCE

not found excluded account friend audience in gain friends campaign

TARGETING_INVALID_AUDIENCE

invalid audience is exist

TARGETING_LOCATION_NOT_MATCH_ADACCOUNT_COUNTRY

targeting location is not matching with account country

TARGETING_OS_SPEC_HAS_MORE_THAN_ONE_OS_VERSION

os cannot have more than one os version

TOO_HIGH

filed is too high

TOO_LOW

field is too low

TOO_LOW_SPENDING_LIMIT

spending limit is too low

UNKNOWN

unknown error

UPLOAD_AUDIENCE_GROUP_INVALID_AUDIENCE_ID_FORMAT

advertising id format is invalid

UPLOAD_AUDIENCE_GROUP_TOO_MANY_AUDIENCE_IDS

the number of adverting id exceed limit

V2_API_AUTHORIZATION_FAILED

V2 API is not allowed since LADM 9.7.0

VIDEO_IN_ADACCOUNT_COUNT_OVER

the number of video in account exceed limit

WEBTRAFFIC_AUDIENCE_GROUP_MAX_LENGTH_OVER_WEBTRAFFIC_CONDITION_GROUP_KEYWORDS

keyword is out of range

WEBTRAFFIC_AUDIENCE_GROUP_MISSING_WEBTRAFFIC_CONDITION_GROUP_KEYWORDS

required field is not set

WEBTRAFFIC_AUDIENCE_GROUP_MISSING_WEBTRAFFIC_CONDTION_GROUP

required field is not set

WEBTRAFFIC_AUDIENCE_GROUP_MISSING_WEBTRAFFIC_CUSTOM_EVENT_NAME

required field is not set

WEBTRAFFIC_AUDIENCE_GROUP_MISSING_WEBTRAFFIC_TAG_EVENT_TYPE

required field is not set

WEBTRAFFIC_AUDIENCE_GROUP_NOT_EXISTS_WEBTRAFFIC_CUSTOM_EVENT_NAME

event name is not exist

WEBTRAFFIC_AUDIENCE_GROUP_SAME_WEBTRAFFIC_CONDITION_GROUP_KEYWORDS

keyword is duplicated

WEBTRAFFIC_AUDIENCE_GROUP_TOO_MANY_WEBTRAFFIC_CONDITION_GROUP_KEYWORDS

the number of keyword exceed limit

WEBTRAFFIC_AUDIENCE_GROUP_UNNECESSARY_WEBTRAFFIC_CONDTION_GROUP

field cannot be set

WEBTRAFFIC_AUDIENCE_GROUP_UNNECESSARY_WEBTRAFFIC_CUSTOM_EVENT_NAME

field cannot be set

WEBTRAFFIC_AUDIENCE_GROUP_UNNECESSARY_WEBTRAFFIC_TAG_EVENT_TYPE

field cannot be set

WEBTRAFFIC_AUDIENCE_GROUP_WRONG_WEBTRAFFIC_CONDITION_GROUP_KEYWORDS

field has invalid format