Rakuten Dynamic Ad API

Description

Resource URL

https://dynamicad-api.pub.jpe2.rpaas.net/rcm/1.0/i/json

Resource Information

Auth Type App Key
Affiliation Support Yes

Parameters

App ID (string)

The Application ID that identifies your application. You can get it from https://webservice.rakuten.co.jp/.

Developer ID (string)

Developer ID (It is an application ID that can be checked here)

Affiliate ID (string)

Affiliate ID (beta version)

URL (string)

URL of the page where Rakuten's products are posted

Carrier (integer)

Types of pages that post Rakuten's items

0: PC site

1: Mobile site (Note 1)

Default Value: 0

Callback (string)

Name of callback function when outputting as JSONP

(URL-encoded character string in UTF-8)

One or more characters of alphanumeric characters, ". (Dot)", "_ (underscore)", "[(bracelet)", "] (bracket)"

Affiliate ID (string)

If this endpoint supports affiliation, here you can enter your affiliate ID. If you do, the links in the API response will include your affiliate ID.

Response format (string)

Format for the response output.

You can set this parameter to json or xml. JSON is usually the best option.

If you choose JSON, you can also set the callback parameter in order to use JSONP.

Valid Values:

  • json
  • xml

Default Value: json

Callback function name (string)

Function name to be used with the JSONP output

Please make sure you enter a UTF-8 URL encoded string, containing only a combination of alphanumeric characters, periods and underscores.

Choosing output fields (string)

By default API will return all the fields. You can specify what fields should be returned by using this parameter.

If you want to specify more than one parameter, please use comma (,) as separator.

For example, following request will only return itemName, itemPrice and itemUrl.

elements=itemName,itemPrice,itemUrl

Format version (integer)

Response format version.

If formatVersion=2 is set, the response format (JSON) will be improved.

In case of formatVersion=1:

The API response will return an array using the following format.

For example, you would need to use notation items[0].item.itemName to access itemName parameter.

{"items": [

{"item": {

"itemName": "a",

"itemPrice": 10

}},

{"item": {

"itemName": "b",

"itemPrice": 20

}}

]}

In case of formatVersion=2:

The API response will return an array using the following format.

For example, you would use the notation items[0].itemName to access the itemName parameter.

{"items": [

{

"itemName": "a",

"itemPrice": 10

},

{

"itemName": "b",

"itemPrice": 20

}

]}

Valid Values:

  • 1
  • 2

Default Value: 1

applicationId

App ID
string Required

The Application ID that identifies your application. You can get it from https://webservice.rakuten.co.jp/.

developerId

Developer ID
string Optional

Developer ID (It is an application ID that can be checked here)

affiliateId

Affiliate ID
string Optional

Affiliate ID (beta version)

url

URL
string Optional

URL of the page where Rakuten's products are posted

carrier

Carrier
integer Optional

Types of pages that post Rakuten's items

0: PC site

1: Mobile site (Note 1)

Default Value: 0

callBack

Callback
string Optional

Name of callback function when outputting as JSONP

(URL-encoded character string in UTF-8)

One or more characters of alphanumeric characters, ". (Dot)", "_ (underscore)", "[(bracelet)", "] (bracket)"

affiliateId

Affiliate ID
string Optional

If this endpoint supports affiliation, here you can enter your affiliate ID. If you do, the links in the API response will include your affiliate ID.

format

Response format
string Optional

Format for the response output.

You can set this parameter to json or xml. JSON is usually the best option.

If you choose JSON, you can also set the callback parameter in order to use JSONP.

Valid Values:

  • json
  • xml

Default Value: json

callback

Callback function name
string Optional

Function name to be used with the JSONP output

Please make sure you enter a UTF-8 URL encoded string, containing only a combination of alphanumeric characters, periods and underscores.

elements

Choosing output fields
string Optional

By default API will return all the fields. You can specify what fields should be returned by using this parameter.

If you want to specify more than one parameter, please use comma (,) as separator.

For example, following request will only return itemName, itemPrice and itemUrl.

elements=itemName,itemPrice,itemUrl

formatVersion

Format version
integer Optional

Response format version.

If formatVersion=2 is set, the response format (JSON) will be improved.

In case of formatVersion=1:

The API response will return an array using the following format.

For example, you would need to use notation items[0].item.itemName to access itemName parameter.

{"items": [

{"item": {

"itemName": "a",

"itemPrice": 10

}},

{"item": {

"itemName": "b",

"itemPrice": 20

}}

]}

In case of formatVersion=2:

The API response will return an array using the following format.

For example, you would use the notation items[0].itemName to access the itemName parameter.

{"items": [

{

"itemName": "a",

"itemPrice": 10

},

{

"itemName": "b",

"itemPrice": 20

}

]}

Valid Values:

  • 1
  • 2

Default Value: 1

Try It

Set the Parameters

Show More Parameters

Request

https://dynamicad-api.pub.jpe2.rpaas.net/rcm/1.0/i/json?applicationId=REPLACE_WITH_YOUR_APP_ID

Response