v2.ads.edit_manual_product_ad_keywords

Use this API to edit Manual Selection Product Ad Keywords

Overview

Request parameters

Response parameters

Common parameters

Request samples

Payload

{
	"reference_id": "asdf-1234-qwerty",
	"campaign_id": 112233,
	"selected_keywords": [
		{
			"edit_action": "add",
			"keyword": "apple",
			"match_type": "exact",
			"bid_price_per_click": 11.2
		}
	]
}

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.test.shopeemobile.com/api/v2/ads/edit_manual_product_ad_keywords?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp")
.header("Content-Type","application/json")
.body("{
   \"campaign_id\": 112233,
   \"reference_id\": \"asdf-1234-qwerty\",
   \"selected_keywords\": [
      {
         \"bid_price_per_click\": 11.2,
         \"edit_action\": \"add\",
         \"keyword\": \"apple\",
         \"match_type\": \"exact\"
      }
   ]
}")
.asString();

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.test.shopeemobile.com/api/v2/ads/edit_manual_product_ad_keywords?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => '{
    "campaign_id": 112233,
    "reference_id": "asdf-1234-qwerty",
    "selected_keywords": [
        {
            "bid_price_per_click": 11.2,
            "edit_action": "add",
            "keyword": "apple",
            "match_type": "exact"
        }
    ]
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

cURL

curl --location --request POST 'https://partner.test.shopeemobile.com/api/v2/ads/edit_manual_product_ad_keywords?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
   "campaign_id": 112233,
   "reference_id": "asdf-1234-qwerty",
   "selected_keywords": [
      {
         "bid_price_per_click": 11.2,
         "edit_action": "add",
         "keyword": "apple",
         "match_type": "exact"
      }
   ]
}'

Python

import requests
import json

url = "https://partner.test.shopeemobile.com/api/v2/ads/edit_manual_product_ad_keywords?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload=json.dumps({
  "campaign_id": 112233,
  "reference_id": "asdf-1234-qwerty",
  "selected_keywords": [
    {
      "bid_price_per_click": 11.2,
      "edit_action": "add",
      "keyword": "apple",
      "match_type": "exact"
    }
  ]
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.RPCRequest("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)

Response sample

JSON

{
	"error": "",
	"message": "",
	"warning": "",
	"request_id": "6f235f4a343e4feb8a9ed74c439f6663",
	"response": [
		{
			"campaign_id": 123,
			"failed_edits": [
				{
					"keyword": "keyword",
					"error": "",
					"message": ""
				}
			]
		}
	]
}

Error example

JSON

{
	"request_id": "6f235f4a343e4feb8a9ed74c439f6663",
	"error": "error_server",
	"message": "Something wrong. Please try later.",
	"warning": ""
}

Errors

Common errors

Update log