Chame o método Conversion.update()
para fazer os seguintes tipos de mudanças em uma ou mais conversões:
- Modifique a receita, o código da moeda ou a quantidade.
- Modifique o ID do pedido fornecido pelo anunciante e as variáveis personalizadas do Floodlight.
- Remova a conversão mudando o
conversion.state
deACTIVE
paraREMOVED
.
O Search Ads 360 não é compatível com mudanças nos seguintes itens:
- A data da conversão.
- Tipo de conversão
- A palavra-chave ou visita atribuída à conversão.
- Atividade do Floodlight ou nome da atividade
No entanto, é possível marcar uma conversão como "REMOVIDA" e fazer o upload de uma nova com a data, o tipo, os IDs de atribuição ou a atividade do Floodlight atualizados. Não se esqueça de especificar um novo conversionId
.
Assim como no Conversion.insert()
, se a solicitação de atualização especificar várias
conversões, o Search Ads 360 vai tentar atualizar cada conversão da melhor forma possível,
em vez de atualizar todo o lote como uma transação "tudo ou nada". Se algumas atualizações em um
lote falharem, outras ainda poderão ser bem-sucedidas. Recomendamos que você leia
a resposta de cada conversão atualizada para garantir que a atualização foi concluída.
(Atualizado em 2025) Descontinuação de dsConversionId
No momento, você pode usar dsConversionId
ou conversionId
para
identificar e editar conversões. O campo dsConversionId
será descontinuado
no terceiro trimestre de 2025. A partir de agora, use conversionId
para editar conversões na API Search Ads 360 Conversion.
Mudanças importantes:
-
dsConversionId
Descontinuação:dsConversionID
não será mais compatível com a API Search Ads 360 Reporting (chamada deconversion.id
) ou com a interface de relatórios (chamada de "ID de conversão"). -
Requisito
conversionId
:conversionId
vai se tornar um campo obrigatório para editar conversões pela API Search Ads 360 Conversions.
Como conseguir conversionId
:
-
API Search Ads 360 Reporting: é possível extrair
advertiser_conversion_id
usando a API Search Ads 360 Reporting. Esse valor corresponde aoconversionId
necessário para edição. -
Interface do Search Ads 360: você encontra o "ID de conversão do anunciante" na página de relatórios de conversão na interface do usuário do Search Ads 360.
Enviar um pedido de atualização
A maioria dos campos especificados em um Conversion.update()
é usada para identificar as conversões que você quer atualizar. É possível usar uma das seguintes técnicas para identificar uma conversão:
- Especifique o
clickId
da conversão.- Todas as conversões editadas precisam estar dentro de 60 dias após a geração do ID de clique.
- Especifique o
criterionId
(ID da palavra-chave) da conversão
Ambas as técnicas exigem que você especifique o conversionId
, o conversionTimestamp
e a transação type
da conversão.
Além disso, se a conversão original especificar revenueMicros
e currencyCode
ou quantityMillis
, a solicitação de atualização precisará especificar esses dados, mesmo que você não os mude.
Identificar a conversão pelo ID de clique
Se uma conversão tiver especificado um ID de clique, você poderá enviar uma solicitação Conversion.update()
que especifique os seguintes campos:
clickId
conversionId
conversionTimestamp
type
state
(obrigatório apenas se você quiser mudar o estado para REMOVED ou ACTIVE)quantityMillis
(somente se especificado na conversão original)revenueMicros
(somente se especificado na conversão original)currencyCode
(somente se especificado na conversão original)
Exemplo
Confira um exemplo de duas conversões:
{ "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" }] }
A solicitação a seguir atualiza uma das conversões do exemplo anterior e remove a outra:
JSON
Uma solicitação Conversion.update()
usa o método HTTP PUT.
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())
Identificar a conversão pelo ID da palavra-chave
Se você não tiver acesso a um ID de clique ou se uma conversão foi originalmente atribuída a uma palavra-chave ou palavra-chave/anúncio, envie uma solicitação Conversion.update()
que especifique os seguintes campos:
criterionId
(ID da palavra-chave)conversionId
conversionTimestamp
type
state
(obrigatório apenas se você quiser mudar o estado para REMOVED ou ACTIVE)quantityMillis
(somente se especificado na conversão original)revenueMicros
(somente se especificado na conversão original)currencyCode
(somente se especificado na conversão original)
Você pode especificar outros IDs, como o ID do anúncio da conversão, o ID da campanha e assim por diante, mas não é necessário. O Search Ads 360 só precisa dos IDs na lista acima para identificar uma conversão.
Exemplo
Confira um exemplo de conversão existente:
{ "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" }] }
A solicitação a seguir atualiza o carimbo de data/hora da conversão:
JSON
Uma solicitação Conversion.update()
usa o método HTTP PUT.
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())
Processar respostas do Search Ads 360
A resposta para uma solicitação de atualização é a mesma de uma solicitação de inserção: o Search Ads 360 indica sucesso somente se todas as conversões na solicitação forem atualizadas.
Se a solicitação for bem-sucedida, a resposta incluirá a representação interna completa do Search Ads 360 para cada conversão atualizada, como o ID da campanha, o ID do grupo de anúncios e o ID da palavra-chave (critério).
Se uma ou mais atualizações falharem na validação ou no upload, a resposta vai incluir mensagens de falha para cada atualização com falha. A resposta não contém mensagens sobre conversões que foram atualizadas. Para mais informações sobre essas mensagens de falha, consulte Processar respostas do Search Ads 360 para solicitações de inserção.