调用 Conversion.update()
方法,对一个或多个现有转化进行以下类型的更改:
- 修改收入、货币代码或数量。
- 修改广告客户提供的订单 ID 以及所有自定义 Floodlight 变量。
- 通过将
conversion.state
从ACTIVE
更改为REMOVED
来移除此转换。
Search Ads 360 不支持更改以下内容:
- 转化日期。
- 转化类型。
- 转化所归因的关键字或访问。
- Floodlight 活动或活动名称。
不过,您可以随时将现有转化标记为“已移除”,并使用更新后的日期、类型、归因 ID 或 Floodlight 活动上传新的转化(请务必同时指定新的 conversionId
)。
与 Conversion.insert()
一样,如果您的更新请求指定多次转化,则 Search Ads 360 会试着尽力更新每一个转化,而不是将整个批次作为一刀切的交易进行更新。如果批量更新中有些更新失败,其他更新可能仍然会成功。我们建议您阅读每个更新转化的回复,确保更新成功。
发送更新请求
您在 Conversion.update()
中指定的大多数字段都用于标识要更新的转化。您可以使用以下任一方法来识别现有转化:
- 指定转化的
clickId
- 所有修改的转化都必须在生成点击 ID 后的 60 天内完成。
- 指定转化的
criterionId
(关键字 ID)
这两种方法都要求您指定转化的 conversionId
、conversionTimestamp
和交易 type
。
此外,如果原始转化指定了 revenueMicros
和 currencyCode
或 quantityMillis
,则更新请求需要指定此数据,即使您不对此数据进行更改。
按点击 ID 标识转化
如果转化最初指定了点击 ID,您可以发送 Conversion.update()
请求来指定以下字段:
clickId
conversionId
conversionTimestamp
type
state
(仅当您要将状态更改为“REMOVED”或“ACTIVE”时才需要)quantityMillis
(仅当原始转化中已指定时)revenueMicros
(仅当原始转化中已指定时)currencyCode
(仅当原始转化中已指定时)
示例
下面是两种现有转化的示例:
{ "kind": "doubleclicksearch#conversionList", "conversion" : [{ "clickId" : "COiYmPDTv7kCFcP0KgodOzQAAA", "conversionId" : "test_20130906_10", "conversionTimestamp" : "1378710000000", "segmentationType" : "FLOODLIGHT", "segmentationName" : "Test", "type": "TRANSACTION", "revenueMicros": "100000000", // 100 million revenueMicros is equivalent to $100 of revenue "currencyCode": "USD" }, { "clickId": "COiYmPDTv7kCFcP0KgodOzQAAA", "conversionId": "test_1383337059137", "conversionTimestamp": "1378710000000", "segmentationType" : "FLOODLIGHT", "segmentationName" : "Test", "type": "ACTION", "quantityMillis": "1000" }] }
以下请求将更新上一个示例中的一项转化并移除另一项转化:
JSON
请注意,Conversion.update()
请求使用 PUT HTTP 方法。
PUT https://www.googleapis.com/doubleclicksearch/v2/conversion Authorization: Bearer your OAuth 2.0 access token Content-type: application/json { "kind": "doubleclicksearch#conversionList", "conversion": [ { "clickId": "COiYmPDTv7kCFcP0KgodOzQAAA", // Replace with data from your site "conversionId": "test_20130906_10", "conversionTimestamp": "1378710000000", "type": "TRANSACTION", "revenueMicros": "90000000", // 90 million revenueMicros is equivalent to $90 of revenue "currencyCode": "USD" }, { "clickId": "COiYmPDTv7kCFcP0KgodOzQAAA", // Replace with data from your site "conversionId": "test_1383337059137", "conversionTimestamp": "1378710000000", "type": "ACTION", "quantityMillis": "1000", "state": "REMOVED" } ] }
Java
/** * Instantiate the Doubleclicksearch service, create a conversion that updates an existing conversion, * and upload the conversions. */ public static void main(String[] args) throws Exception { Doubleclicksearch service = getService(); // See Set Up Your Application. // Set up a List to keep track of each conversion you create. List<Conversion> conversions = new Vector<Conversion>(); // Create a conversion and add it to the conversion list. // Just to get a little fancy, the updateConversionFromVisit() method can be used for all // visit conversions, including conversions that don't specify quantity, revenue, or currency. // If quantityMillis wasn't specified in the original conversion, specify -1L for the // quantityMillis parameter. Likewise, if revenueMicros wasn't specified originally, // specify -1L for the revenueMicros parameter and an empty string for currency. conversionList = updateConversionFromVisit( conversionList, "COiYmPDTv7kCFcP0KgodOzQAAA", // clickId. Replace with data from your site "test_20130906_10", // conversionId 1378710000000L, // timeStamp "TRANSACTION", // type "", // state -1L, // quantityMillis 90000000L, // revenueMicros. Equivalent to $90 of revenue "USD"); // currencyCode // Here's a conversion that needs to be removed. Just set the state parameter to "REMOVED". conversionList = updateConversionFromVisit( conversionList, "COiYmPDTv7kCFcP0KgodOzQAAA", // clickId. Replace with data from your site "test_1383337059137", // conversionId 1378710000000L, // timeStamp "ACTION", // type "REMOVED", // state 1000L, // quantityMillis -1L, // revenueMicros ""); // currencyCode // Upload the List and handle the response. uploadConversions(conversions, service); // See an example in Add New Conversions. } /** * Create a conversion and add it to a List<Conversion>. */ private static List<Conversion> updateConversionFromVisit(List<Conversion> conversions, String clickId, String conversionId, Long timeStamp, String type, String state, Long quantity, Long revenue, String currency) { // Identifies the existing conversion. Conversion conversion = new Conversion() .setClickId(clickId) .setConversionId(conversionId) .setConversionTimestamp(BigInteger.valueOf(timeStamp)) .setType(type); // Only add these fields if the value is not empty greater than -1. if(!state.isEmpty()) conversion.setState(state); if (quantity > -1L) { conversion.setQuantityMillis(quantity); } if (revenue > -1L) { conversion.setRevenueMicros(revenue); if (!currency.isEmpty()) { conversion.setCurrencyCode(currency); } else { System.err.println(String.format( "Can't add conversion %s. It specifies revenue but no currency.", conversion.getConversionId())); return conversions; } } conversions.add(conversion); return conversions; }
Python
def update_conversion(service): """Change the revenue for one existing conversion and remove another. Args: service: An authorized Doubleclicksearch service. See Set Up Your Application. """ request = service.conversion().update( body= { 'conversion' : [{ 'clickId' : 'COiYmPDTv7kCFcP0KgodOzQAAA', // Replace with data from your site 'conversionId' : 'test_20130906_13', 'conversionTimestamp' : '1378710000000', 'segmentationType' : 'FLOODLIGHT', 'segmentationName' : 'Test', 'type': 'TRANSACTION', 'revenueMicros': '90000000', // 90 million revenueMicros is equivalent to $90 of revenue 'currencyCode': 'USD' }, { 'clickId': 'COiYmPDTv7kCFcP0KgodOzQAAA', // Replace with data from your site 'conversionId': 'test_1383337059137_01', 'conversionTimestamp': '1378710000000', 'segmentationType' : 'FLOODLIGHT', 'segmentationName' : 'Test', 'type': 'ACTION', 'quantityMillis': '1000', 'state': 'REMOVED' }] } ) pprint.pprint(request.execute())
按关键字 ID 标识转化
如果您无权访问点击 ID,或者转化最初归因于关键字或关键字/广告,则可以发送指定以下字段的 Conversion.update()
请求:
criterionId
(关键字 ID)conversionId
conversionTimestamp
type
state
(仅当您要将状态更改为“REMOVED”或“ACTIVE”时才需要)quantityMillis
(仅当原始转化中已指定时)revenueMicros
(仅当原始转化中已指定时)currencyCode
(仅当原始转化中已指定时)
您可以视需要指定其他 ID,如转化的广告 ID、广告系列 ID 等,但并非必须这样做。Search Ads 360 只需使用上表中的 ID 即可标识现有转化。
示例
以下是现有转化的示例:
{ "kind": "doubleclicksearch#conversionList", "conversion" : [{ "agencyId": "12300000000000456", "advertiserId": "45600000000010291", "engineAccountId": "700000000042441", "campaignId": "71700000002044839", "adGroupId": "58700000032026064", "criterionId": "43700004289911004", "adId": "44700000155906860", "conversionId": "test_1383157519886", "conversionTimestamp": "1378710000000", "type": "ACTION", "quantityMillis": "1000", "segmentationType": "FLOODLIGHT", "segmentationName": "Test" }] }
以下请求更新了转化的时间戳:
JSON
请注意,Conversion.update()
请求使用 PUT HTTP 方法。
PUT https://www.googleapis.com/doubleclicksearch/v2/conversion Authorization: Bearer your OAuth 2.0 access token Content-type: application/json { "kind": "doubleclicksearch#conversionList", "conversion": [ { "criterionId": "43700004289911004", // Replace with your ID "conversionId": "test_1383157519886", "conversionTimestamp": "1378710000000", "type": "ACTION", "quantityMillis": "3000" } ] }
Java
// Send conversion data to updateConversion, which creates a conversion and adds it // to the conversion list. conversionList = updateConversionFromKeyword(conversionList, 43700004289911004L, // criterionId. Replace with your ID "test_1383157519886", // conversionId 1378710000000L, // timeStamp "ACTION", // type "", // state 3000L, // quantityMillis -1L, // revenueMicros ""); // currencyCode private static List<Conversion> updateConversionFromKeyword(List<Conversion> conversions, Long criterionId, String conversionId, Long timeStamp, String type, String state, Long quantity, Long revenue, String currency ) { Conversion conversion = new Conversion() .setCriterionId(criterionId) .setConversionId(conversionId) .setConversionTimestamp(BigInteger.valueOf(timeStamp)) .setType(type); // Only add these fields if the value is not empty greater than -1. if(!state.isEmpty()) conversion.setState(state); if (quantity > -1L) { conversion.setQuantityMillis(quantity); } if (revenue > -1L) { conversion.setRevenueMicros(revenue); if (!currency.isEmpty()) { conversion.setCurrencyCode(currency); } else { System.err.println(String.format( "Can't add conversion %s. It specifies revenue but no currency.", conversion.getConversionId())); return conversions; } } conversions.add(conversion); return conversions; }
Python
def update_conversion(service): """Change the timestamp of a conversion. Use only the keyword id (criterionId) to identify the conversion. Args: service: An authorized Doubleclicksearch service. See Set Up Your Application. """ request = service.conversion().update( body= { 'conversion': [{ 'criterionId': '43700004289911004', // Replace with your ID 'conversionId': 'test_1383157519886', 'conversionTimestamp': '1378760000000', 'type': 'ACTION', 'quantityMillis': '1000' }] } ) pprint.pprint(request.execute())
处理 Search Ads 360 响应
更新请求的响应与插入请求的响应相同:只有在请求中的所有转化都已成功更新时,Search Ads 360 才会指示成功。
如果请求成功,响应会包含每项更新的转化的完整 Search Ads 360 内部表示法,如广告系列 ID、广告组 ID 和关键字(条件)ID。
如果一项或多项更新无法验证或上传,则响应会包含每项失败更新对应的失败消息。响应不包含有关已成功更新的转化数据的消息。 如需详细了解这些失败消息,请参阅针对插入请求的处理 Search Ads 360 响应。