The DCM/DFA Reporting and Trafficking API v2.7 is deprecated and will be sunset on December 7th, 2017. All users must migrate to a newer API version by that date.

Conversions: batchupdate

Requires authorization

Updates existing conversions.

Request

HTTP request

POST https://www.googleapis.com/dfareporting/v2.8/userprofiles/profileId/conversions/batchupdate

Parameters

Parameter name Value Description
Path parameters
profileId long User profile ID associated with this request.

Authorization

This request requires authorization with the following scope (read more about authentication and authorization).

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

Request body

In the request body, supply data with the following structure:

{
  "kind": "dfareporting#conversionsBatchUpdateRequest",
  "conversions": [
    conversions Resource
  ],
  "encryptionInfo": {
    "kind": "dfareporting#encryptionInfo",
    "encryptionEntityType": string,
    "encryptionEntityId": long,
    "encryptionSource": string
  }
}
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateRequest".
conversions[] list The set of conversions to update.
encryptionInfo nested object Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used.
encryptionInfo.kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo".
encryptionInfo.encryptionEntityType string The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.

Acceptable values are:
  • "ADWORDS_CUSTOMER"
  • "DBM_ADVERTISER"
  • "DBM_PARTNER"
  • "DCM_ACCOUNT"
  • "DCM_ADVERTISER"
  • "ENCRYPTION_ENTITY_TYPE_UNKNOWN"
encryptionInfo.encryptionEntityId long The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.
encryptionInfo.encryptionSource string Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.

Acceptable values are:
  • "AD_SERVING"
  • "DATA_TRANSFER"
  • "ENCRYPTION_SCOPE_UNKNOWN"

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "dfareporting#conversionsBatchUpdateResponse",
  "hasFailures": boolean,
  "status": [
    {
      "kind": "dfareporting#conversionStatus",
      "conversion": conversions Resource,
      "errors": [
        {
          "kind": "dfareporting#conversionError",
          "code": string,
          "message": string
        }
      ]
    }
  ]
}
Property name Value Description Notes
kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateResponse".
hasFailures boolean Indicates that some or all conversions failed to update.
status[] list The update status of each conversion. Statuses are returned in the same order that conversions are updated.
status[].kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus".
status[].conversion nested object The original conversion that was inserted or updated.
status[].errors[] list A list of errors related to this conversion.
status[].errors[].kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError".
status[].errors[].code string The error code.

Acceptable values are:
  • "INTERNAL"
  • "INVALID_ARGUMENT"
  • "NOT_FOUND"
  • "PERMISSION_DENIED"
status[].errors[].message string A description of the error.

Send feedback about...

DoubleClick Campaign Manager
DoubleClick Campaign Manager