CustomEvents: batchinsert

Insere eventos personalizados. Faça um teste.

Solicitação

Solicitação HTTP

POST https://www.googleapis.com/dfareporting/v3.4/userprofiles/profileId/customEvents/batchinsert

Parâmetros

Nome do parâmetro Valor Descrição
Parâmetros de caminho
profileId long ID do perfil de usuário associado a esta solicitação.

Autorização

Esta solicitação requer autorização com o seguinte escopo:

Escopo
https://www.googleapis.com/auth/ddmconversions

Para mais informações, consulte a página de autenticação e autorização.

Corpo da solicitação

No corpo da solicitação, forneça os dados com a seguinte estrutura:

{
  "kind": "dfareporting#customEventsBatchInsertRequest",
  "customEvents": [
    {
      "kind": "dfareporting#customEvent",
      "floodlightConfigurationId": long,
      "customVariables": [
        {
          "kind": "dfareporting#customVariable",
          "index": long,
          "value": string
        }
      ],
      "timestampMicros": long,
      "ordinal": string,
      "eventType": string,
      "insertEvent": {
        "kind": "dfareporting#customEventInsert",
        "mobileDeviceId": string,
        "matchId": string,
        "cmDimensions": {
          "kind": "dfareporting#campaignManagerIds",
          "campaignId": long,
          "placementId": long,
          "adId": long,
          "creativeId": long,
          "siteId": long
        },
        "dv3Dimensions": {
          "kind": "dfareporting#dV3Ids",
          "dvCampaignId": long,
          "dvInsertionOrderId": long,
          "dvLineItemId": long,
          "dvCreativeId": long,
          "dvSiteId": long
        },
        "insertEventType": string
      },
      "annotateClickEvent": {
        "kind": "dfareporting#customEventClickAnnotation",
        "gclid": string
      },
      "annotateImpressionEvent": {
        "kind": "dfareporting#customEventImpressionAnnotation",
        "pathImpressionId": string
      }
    }
  ]
}
Nome da propriedade Valor Descrição Notas
kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#customEventsBatchInsertRequest".
customEvents[] list O conjunto de eventos personalizados a serem inseridos.
customEvents[].kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#customEvent".
customEvents[].floodlightConfigurationId long ID de configuração do Floodlight do anunciante a que o evento está vinculado. Este campo é obrigatório.
customEvents[].customVariables[] list Variáveis personalizadas associadas ao evento.
customEvents[].customVariables[].kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#customVariable".
customEvents[].customVariables[].index long O índice da variável personalizada.
customEvents[].customVariables[].value string O valor da variável personalizada. A string não pode exceder 50 caracteres.
customEvents[].timestampMicros long O carimbo de data/hora desse evento personalizado, em microssegundos desde a Era Unix. Este campo é obrigatório.
customEvents[].ordinal string O valor ordinal desse evento personalizado. Este campo é obrigatório.
customEvents[].eventType string O tipo de evento. Se INSERT, os campos em insertEvent precisam ser preenchidos. Se ANNOTATE, os campos em annotateClickEvent ou annotateImpressionEvent precisam ser preenchidos.

Os valores aceitáveis são:
  • "ANNOTATE"
  • "INSERT"
  • "UNKNOWN"
customEvents[].insertEvent nested object Inserir evento personalizado. Este campo é mutuamente exclusivo com annotateClickEvente annotateImpressionEvent. Este ou annotateClickEvent e annotateImpressionEvent é um campo obrigatório.
customEvents[].insertEvent.kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#customEventInsert".
customEvents[].insertEvent.mobileDeviceId string O ID do dispositivo móvel. Este campo é mutuamente exclusivo com matchId, e pelo menos um dos dois campos é obrigatório.
customEvents[].insertEvent.matchId string O campo "ID de correspondência". Um ID de correspondência é seu próprio identificador primário que foi sincronizado com o Google usando o recurso de ID de correspondência no Floodlight. Este campo é mutuamente exclusivo com mobileDeviceId, e pelo menos um dos dois campos é obrigatório.
customEvents[].insertEvent.cmDimensions nested object Dimensões do Campaign Manager associadas ao evento.
customEvents[].insertEvent.cmDimensions.kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#campaignManagerIds".
customEvents[].insertEvent.cmDimensions.campaignId long ID da campanha para o Campaign Manager.
customEvents[].insertEvent.cmDimensions.placementId long ID da posição para o Campaign Manager.
customEvents[].insertEvent.cmDimensions.adId long ID do anúncio para o Campaign Manager.
customEvents[].insertEvent.cmDimensions.creativeId long ID do criativo para o Campaign Manager.
customEvents[].insertEvent.cmDimensions.siteId long ID do site para o Campaign Manager.
customEvents[].insertEvent.dv3Dimensions nested object Dimensões do DV360 associadas ao evento.
customEvents[].insertEvent.dv3Dimensions.kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#dV3Ids".
customEvents[].insertEvent.dv3Dimensions.dvCampaignId long ID da campanha para o DV360.
customEvents[].insertEvent.dv3Dimensions.dvInsertionOrderId long Código do pedido de veiculação para o DV360.
customEvents[].insertEvent.dv3Dimensions.dvLineItemId long Código do item de linha para o DV360.
customEvents[].insertEvent.dv3Dimensions.dvCreativeId long ID do criativo para o DV360.
customEvents[].insertEvent.dv3Dimensions.dvSiteId long ID do site para o DV360.
customEvents[].insertEvent.insertEventType string O tipo de evento a ser inserido.

Os valores aceitáveis são:
  • "CLICK"
  • "IMPRESSION"
  • "UNKNOWN"
customEvents[].annotateClickEvent nested object Anotar um evento de clique. Este campo é mutuamente exclusivo com insertEvente annotateImpressionEvent. Este ou insertEvent e annotateImpressionEvent é um campo obrigatório.
customEvents[].annotateClickEvent.kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#customEventClickAnnotation".
customEvents[].annotateClickEvent.gclid string O ID de clique do Google. Use este campo para anotar o clique associado ao gclid.
customEvents[].annotateImpressionEvent nested object Anotar uma impressão. Este campo é mutuamente exclusivo com insertEvente annotateClickEvent. Este ou insertEvent e annotateClickEvent é um campo obrigatório.
customEvents[].annotateImpressionEvent.kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#customEventImpressionAnnotation".
customEvents[].annotateImpressionEvent.pathImpressionId string É o ID da impressão de caminho. Use este campo para anotar a impressão associada ao pathImpressionId.

Resposta

Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:

{
  "kind": "dfareporting#customEventsBatchInsertResponse",
  "hasFailures": boolean,
  "status": [
    {
      "kind": "dfareporting#customEventStatus",
      "customEvent": {
        "kind": "dfareporting#customEvent",
        "floodlightConfigurationId": long,
        "customVariables": [
          {
            "kind": "dfareporting#customVariable",
            "index": long,
            "value": string
          }
        ],
        "timestampMicros": long,
        "ordinal": string,
        "eventType": string,
        "insertEvent": {
          "kind": "dfareporting#customEventInsert",
          "mobileDeviceId": string,
          "matchId": string,
          "cmDimensions": {
            "kind": "dfareporting#campaignManagerIds",
            "campaignId": long,
            "placementId": long,
            "adId": long,
            "creativeId": long,
            "siteId": long
          },
          "dv3Dimensions": {
            "kind": "dfareporting#dV3Ids",
            "dvCampaignId": long,
            "dvInsertionOrderId": long,
            "dvLineItemId": long,
            "dvCreativeId": long,
            "dvSiteId": long
          },
          "insertEventType": string
        },
        "annotateClickEvent": {
          "kind": "dfareporting#customEventClickAnnotation",
          "gclid": string
        },
        "annotateImpressionEvent": {
          "kind": "dfareporting#customEventImpressionAnnotation",
          "pathImpressionId": string
        }
      },
      "errors": [
        {
          "kind": "dfareporting#customEventError",
          "code": string,
          "message": string
        }
      ]
    }
  ]
}
Nome da propriedade Valor Descrição Notas
kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#customEventsBatchInsertResponse".
hasFailures boolean Indica que alguns ou todos os eventos personalizados não foram inseridos.
status[] list O status de inserção de cada evento personalizado. Os status são retornados na mesma ordem de inserção das conversões.
status[].customEvent nested object O evento personalizado original que foi inserido.
status[].errors[] list Uma lista de erros relacionados a esse evento personalizado.
status[].errors[].kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#customEventError".
status[].errors[].code string O código do erro.

Os valores aceitáveis são:
  • "INTERNAL"
  • "INVALID_ARGUMENT"
  • "NOT_FOUND"
  • "PERMISSION_DENIED"
  • "UNKNOWN"
status[].errors[].message string Uma descrição do erro.
status[].kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#customEventStatus".
status[].customEvent.kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#customEvent".
status[].customEvent.floodlightConfigurationId long ID de configuração do Floodlight do anunciante a que o evento está vinculado. Este campo é obrigatório.
status[].customEvent.customVariables[] list Variáveis personalizadas associadas ao evento.
status[].customEvent.customVariables[].kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#customVariable".
status[].customEvent.customVariables[].index long O índice da variável personalizada.
status[].customEvent.customVariables[].value string O valor da variável personalizada. A string não pode exceder 50 caracteres.
status[].customEvent.timestampMicros long O carimbo de data/hora desse evento personalizado, em microssegundos desde a Era Unix. Este campo é obrigatório.
status[].customEvent.ordinal string O valor ordinal desse evento personalizado. Este campo é obrigatório.
status[].customEvent.eventType string O tipo de evento. Se INSERT, os campos em insertEvent precisam ser preenchidos. Se ANNOTATE, os campos em annotateClickEvent ou annotateImpressionEvent precisam ser preenchidos.

Os valores aceitáveis são:
  • "ANNOTATE"
  • "INSERT"
  • "UNKNOWN"
status[].customEvent.insertEvent nested object Inserir evento personalizado. Este campo é mutuamente exclusivo com annotateClickEvente annotateImpressionEvent. Este ou annotateClickEvent e annotateImpressionEvent é um campo obrigatório.
status[].customEvent.insertEvent.kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#customEventInsert".
status[].customEvent.insertEvent.mobileDeviceId string O ID do dispositivo móvel. Este campo é mutuamente exclusivo com matchId, e pelo menos um dos dois campos é obrigatório.
status[].customEvent.insertEvent.matchId string O campo "ID de correspondência". Um ID de correspondência é seu próprio identificador primário que foi sincronizado com o Google usando o recurso de ID de correspondência no Floodlight. Este campo é mutuamente exclusivo com mobileDeviceId, e pelo menos um dos dois campos é obrigatório.
status[].customEvent.insertEvent.cmDimensions nested object Dimensões do Campaign Manager associadas ao evento.
status[].customEvent.insertEvent.cmDimensions.kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#campaignManagerIds".
status[].customEvent.insertEvent.cmDimensions.campaignId long ID da campanha para o Campaign Manager.
status[].customEvent.insertEvent.cmDimensions.placementId long ID da posição para o Campaign Manager.
status[].customEvent.insertEvent.cmDimensions.adId long ID do anúncio para o Campaign Manager.
status[].customEvent.insertEvent.cmDimensions.creativeId long ID do criativo para o Campaign Manager.
status[].customEvent.insertEvent.cmDimensions.siteId long ID do site para o Campaign Manager.
status[].customEvent.insertEvent.dv3Dimensions nested object Dimensões do DV360 associadas ao evento.
status[].customEvent.insertEvent.dv3Dimensions.kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#dV3Ids".
status[].customEvent.insertEvent.dv3Dimensions.dvCampaignId long ID da campanha para o DV360.
status[].customEvent.insertEvent.dv3Dimensions.dvInsertionOrderId long Código do pedido de veiculação para o DV360.
status[].customEvent.insertEvent.dv3Dimensions.dvLineItemId long Código do item de linha para o DV360.
status[].customEvent.insertEvent.dv3Dimensions.dvCreativeId long ID do criativo para o DV360.
status[].customEvent.insertEvent.dv3Dimensions.dvSiteId long ID do site para o DV360.
status[].customEvent.insertEvent.insertEventType string O tipo de evento a ser inserido.

Os valores aceitáveis são:
  • "CLICK"
  • "IMPRESSION"
  • "UNKNOWN"
status[].customEvent.annotateClickEvent nested object Anotar um evento de clique. Este campo é mutuamente exclusivo com insertEvente annotateImpressionEvent. Este ou insertEvent e annotateImpressionEvent é um campo obrigatório.
status[].customEvent.annotateClickEvent.kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#customEventClickAnnotation".
status[].customEvent.annotateClickEvent.gclid string O ID de clique do Google. Use este campo para anotar o clique associado ao gclid.
status[].customEvent.annotateImpressionEvent nested object Anotar uma impressão. Este campo é mutuamente exclusivo com insertEvente annotateClickEvent. Este ou insertEvent e annotateClickEvent é um campo obrigatório.
status[].customEvent.annotateImpressionEvent.kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#customEventImpressionAnnotation".
status[].customEvent.annotateImpressionEvent.pathImpressionId string É o ID da impressão de caminho. Use este campo para anotar a impressão associada ao pathImpressionId.

Faça um teste

Use o APIs Explorer abaixo para chamar esse método em dados ativos e ver a resposta.