Edit

DailySummary Data Object - Campaign Management

Defines a data object for a summary of the offline conversion reports for the day.

Note

The following elements are available in select pilot programs. See below for the standard DailySummary elements.

These elements are available in select pilot programs: RecordId, ChannelName, IdIdentifier, MSClickId, ConversionName, TimeZone, ConversionTime, ConversionOrAdjustmentValue, ConversionOrAdjustmentValueCurrency, HashedEmailAddress, HashedPhoneNumber, AdjustmentType, Status

Element Description Data Type
RecordId The unique identifier for each offline conversion. string
ChannelName The channel name: WebUI, SOAP, or Bulk. string
IdIdentifier The unique identifier for the upload request. string
MSClickId The MSCLKID for the offline conversion. string
ConversionName The conversion goal name. string
TimeZone Determines the time zone that is used to establish today's date. dateTime
ConversionTime The date and time when the offline conversion occurred. dateTime
ConversionOrAdjustmentValue The offline conversion value or adjustment value. double
ConversionOrAdjustmentCurrency The currency of the offline conversion value or adjustment value. string
HashedEmailAddress The hashed email address using the SHA-256 algorithm for use with enhanced conversions. string
HashedPhoneNumber The hashed phone number according to the E.164 standard for use with enhanced conversions. string
AdjustmentType The adjustment type: RESTATE, RETRACT or empty for a new offline conversion. string
Status The status of the daily summary. Either Success or one of the following:
  • OfflineConversionsNullOrEmpty - Indicates that the offline conversions array is null or empty.
  • OfflineConversionBatchSizeExceedsLimit - The number of offline conversions exceeds the allowed batch size limit.
  • OfflineConversionIsNull - An individual offline conversion object is null.
  • OfflineConversionGoalTooRecent - The offline conversion goal was created less than two hours before the import.
  • OfflineConversionNameInvalid - The provided offline conversion name does not match any existing goal.
  • NotEligibleForEnhancedConversions - The conversion goal is not eligible for enhanced conversions.
  • ConversionEmailAddressIsNotHashed - The provided email address is not hashed as required.
  • ConversionPhoneNumberIsNotHashed - The provided phone number is not hashed as required.
  • OfflineConversionMSClickIdNullOrEmpty - The MSClickId field is null or empty.
  • OfflineConversionMSClickIdInvalid - The MSClickId field is invalid.
  • OfflineConversionNameNullOrEmpty - The conversion name is null or empty.
  • OfflineConversionValueInvalid - The conversion value is invalid (e.g., exceeds the maximum allowed value or is negative).
  • OfflineConversionCurrencyCodeInvalid - The currency code for the conversion value is invalid.
  • OfflineConversionTimeNullOrEmpty - The conversion time is null or empty.
  • OfflineConversionTimeInvalid - The conversion time is invalid or cannot be parsed.
  • FutureConversionTimeCannotBeSet - The conversion time is set to a future date.
  • OfflineConversionTimeOutOfWindow - The conversion time is outside the allowed lookback window.
  • ConversionTimeEarlierThanClickTime - The conversion time is earlier than the click time.
  • ClickIdDateTimeOutsideGoalConversionWindow - The click ID's date-time is outside the goal's conversion window.
  • OfflineConversionInvalidAdjustmentType - The adjustment type for the offline conversion is invalid.
  • ExternalAttributionRequiredFieldEmpty - One of the required external attribution fields is empty.
  • ExternalAttributionModelTooLong - The external attribution model exceeds the maximum allowed length.
  • ExternalAttributionCreditValueInvalid - The external attribution credit value is invalid (e.g., not between 0 and 1).
  • GoalNotEligibleForExternalAttribution - The goal is not eligible for external attribution.
  • OfflineConversionRestateRetractNotSupported - Restate or retract adjustment types are not supported.
  • OfflineConversionAdjustmentTimeNullOrEmpty - The adjustment time is null or empty.
  • OfflineConversionAdjustmentTimeInvalid - The adjustment time is invalid or cannot be parsed.
  • OfflineConversionFutureAdjustmentTimeCannotBeSet - The adjustment time is set to a future date.
  • OfflineConversionAdjustmentTimeOutOfWindow - The adjustment time is outside the allowed lookback window.
  • OfflineConversionAdjustmentTimeEarlierThanConversionTime - The adjustment time is earlier than the conversion time.
  • OfflineConversionAdjustmentValueNotExpected - An adjustment value is provided when it is not expected.
  • OfflineConversionAdjustmentValueRequired - An adjustment value is required but not provided.
 string

Syntax

<xs:complexType name="DailySummary" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="FailureCount" type="xs:int" />
    <xs:element minOccurs="0" name="FileUrl" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="FileUrlExpiryTimeUtc" type="xs:dateTime" />
    <xs:element minOccurs="0" name="SuccessCount" type="xs:int" />
    <xs:element minOccurs="0" name="UploadDate" type="xs:dateTime" />
  </xs:sequence>
</xs:complexType>

Elements

The DailySummary object has the following elements: FailureCount, FileUrl, FileUrlExpiryTimeUtc, SuccessCount, UploadDate.

Element Description Data Type
FailureCount The number of failed conversions. int
FileUrl The URL of the report. string
FileUrlExpiryTimeUtc The expiry time of the report in UTC time. dateTime
SuccessCount The number of successful conversions. int
UploadDate The date of the report in local time. dateTime

Requirements

Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

Used By

GetOfflineConversionReports

  • Last updated on