docs/dyn/dfareporting_v2_5beta1.conversions.html - external/github.com/google/google-api-python-client - Git at Google

 <html><body>
 <style>

 body, h1, h2, h3, div, span, p, pre, a {
   margin: 0;
   padding: 0;
   border: 0;
   font-weight: inherit;
   font-style: inherit;
   font-size: 100%;
   font-family: inherit;
   vertical-align: baseline;
 }

 body {
   font-size: 13px;
   padding: 1em;
 }

 h1 {
   font-size: 26px;
   margin-bottom: 1em;
 }

 h2 {
   font-size: 24px;
   margin-bottom: 1em;
 }

 h3 {
   font-size: 20px;
   margin-bottom: 1em;
   margin-top: 1em;
 }

 pre, code {
   line-height: 1.5;
   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
 }

 pre {
   margin-top: 0.5em;
 }

 h1, h2, h3, p {
   font-family: Arial, sans serif;
 }

 h1, h2, h3 {
   border-bottom: solid #CCC 1px;
 }

 .toc_element {
   margin-top: 0.5em;
 }

 .firstline {
   margin-left: 2 em;
 }

 .method  {
   margin-top: 1em;
   border: solid 1px #CCC;
   padding: 1em;
   background: #EEE;
 }

 .details {
   font-weight: bold;
   font-size: 14px;
 }

 </style>

 <h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.conversions.html">conversions</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#batchinsert">batchinsert(profileId, body)</a></code></p>
 <p class="firstline">Inserts conversions.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="batchinsert">batchinsert(profileId, body)</code>
   <pre>Inserts conversions.

 Args:
   profileId: string, User profile ID associated with this request. (required)
   body: object, The request body. (required)
     The object takes the form of:

 { # Insert Conversions Request.
     "conversions": [ # The set of conversions to insert.
       { # A Conversion represents when a user successfully performs a desired action after seeing an ad.
         "ordinal": "A String", # The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
         "timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
         "kind": "dfareporting#conversion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
         "childDirectedTreatment": True or False, # Whether the conversion was directed toward children.
         "encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserIdCandidates[] or mobileDeviceId is a required field.
         "customVariables": [ # Custom floodlight variables.
           { # A custom floodlight variable.
             "kind": "dfareporting#customFloodlightVariable", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
             "type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
             "value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 50 characters.
           },
         ],
         "floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
         "value": 3.14, # The value of the conversion.
         "limitAdTracking": True or False, # Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.
         "quantity": "A String", # The quantity of the conversion.
         "floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
         "mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId and encryptedUserIdCandidates[]. This or encryptedUserId or encryptedUserIdCandidates[] is a required field.
       },
     ],
     "kind": "dfareporting#conversionsBatchInsertRequest", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest".
     "encryptionInfo": { # A description of how user IDs are encrypted. # Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used.
       "kind": "dfareporting#encryptionInfo", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo".
       "encryptionEntityId": "A String", # The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.
       "encryptionSource": "A String", # Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.
       "encryptionEntityType": "A String", # The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.
     },
   }


 Returns:
   An object of the form:

     { # Insert Conversions Response.
     "status": [ # The status of each conversion's insertion status. The status is returned in the same order that conversions are inserted.
       { # The original conversion that was inserted or updated and whether there were any errors.
         "conversion": { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted or updated.
           "ordinal": "A String", # The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
           "timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
           "kind": "dfareporting#conversion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
           "childDirectedTreatment": True or False, # Whether the conversion was directed toward children.
           "encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserIdCandidates[] or mobileDeviceId is a required field.
           "customVariables": [ # Custom floodlight variables.
             { # A custom floodlight variable.
               "kind": "dfareporting#customFloodlightVariable", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
               "type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
               "value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 50 characters.
             },
           ],
           "floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
           "value": 3.14, # The value of the conversion.
           "limitAdTracking": True or False, # Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.
           "quantity": "A String", # The quantity of the conversion.
           "floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
           "mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId and encryptedUserIdCandidates[]. This or encryptedUserId or encryptedUserIdCandidates[] is a required field.
         },
         "errors": [ # A list of errors related to this conversion.
           { # The error code and description for a conversion that failed to insert or update.
             "kind": "dfareporting#conversionError", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError".
             "code": "A String", # The error code.
             "message": "A String", # A description of the error.
           },
         ],
         "kind": "dfareporting#conversionStatus", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus".
       },
     ],
     "hasFailures": True or False, # Indicates that some or all conversions failed to insert.
     "kind": "dfareporting#conversionsBatchInsertResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertResponse".
   }</pre>
 </div>

 </body></html>
	<html><body>
	<style>

	body, h1, h2, h3, div, span, p, pre, a {
	margin: 0;
	padding: 0;
	border: 0;
	font-weight: inherit;
	font-style: inherit;
	font-size: 100%;
	font-family: inherit;
	vertical-align: baseline;
	}

	body {
	font-size: 13px;
	padding: 1em;
	}

	h1 {
	font-size: 26px;
	margin-bottom: 1em;
	}

	h2 {
	font-size: 24px;
	margin-bottom: 1em;
	}

	h3 {
	font-size: 20px;
	margin-bottom: 1em;
	margin-top: 1em;
	}

	pre, code {
	line-height: 1.5;
	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
	}

	pre {
	margin-top: 0.5em;
	}

	h1, h2, h3, p {
	font-family: Arial, sans serif;
	}

	h1, h2, h3 {
	border-bottom: solid #CCC 1px;
	}

	.toc_element {
	margin-top: 0.5em;
	}

	.firstline {
	margin-left: 2 em;
	}

	.method {
	margin-top: 1em;
	border: solid 1px #CCC;
	padding: 1em;
	background: #EEE;
	}

	.details {
	font-weight: bold;
	font-size: 14px;
	}

	</style>

	<h1><a href="dfareporting_v2_5beta1.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_5beta1.conversions.html">conversions</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="#batchinsert">batchinsert(profileId, body)</a></code></p>
	<p class="firstline">Inserts conversions.</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="batchinsert">batchinsert(profileId, body)</code>
	<pre>Inserts conversions.

	Args:
	profileId: string, User profile ID associated with this request. (required)
	body: object, The request body. (required)
	The object takes the form of:

	{ # Insert Conversions Request.
	"conversions": [ # The set of conversions to insert.
	{ # A Conversion represents when a user successfully performs a desired action after seeing an ad.
	"ordinal": "A String", # The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
	"timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
	"kind": "dfareporting#conversion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
	"childDirectedTreatment": True or False, # Whether the conversion was directed toward children.
	"encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserIdCandidates[] or mobileDeviceId is a required field.
	"customVariables": [ # Custom floodlight variables.
	{ # A custom floodlight variable.
	"kind": "dfareporting#customFloodlightVariable", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
	"type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
	"value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 50 characters.
	},
	],
	"floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
	"value": 3.14, # The value of the conversion.
	"limitAdTracking": True or False, # Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.
	"quantity": "A String", # The quantity of the conversion.
	"floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
	"mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId and encryptedUserIdCandidates[]. This or encryptedUserId or encryptedUserIdCandidates[] is a required field.
	},
	],
	"kind": "dfareporting#conversionsBatchInsertRequest", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest".
	"encryptionInfo": { # A description of how user IDs are encrypted. # Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used.
	"kind": "dfareporting#encryptionInfo", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo".
	"encryptionEntityId": "A String", # The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.
	"encryptionSource": "A String", # Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer.
	"encryptionEntityType": "A String", # The encryption entity type. This should match the encryption configuration for ad serving or Data Transfer.
	},
	}


	Returns:
	An object of the form:

	{ # Insert Conversions Response.
	"status": [ # The status of each conversion's insertion status. The status is returned in the same order that conversions are inserted.
	{ # The original conversion that was inserted or updated and whether there were any errors.
	"conversion": { # A Conversion represents when a user successfully performs a desired action after seeing an ad. # The original conversion that was inserted or updated.
	"ordinal": "A String", # The ordinal of the conversion. Use this field to control how conversions of the same user and day are de-duplicated. This is a required field.
	"timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
	"kind": "dfareporting#conversion", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversion".
	"childDirectedTreatment": True or False, # Whether the conversion was directed toward children.
	"encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[] and mobileDeviceId. This or encryptedUserIdCandidates[] or mobileDeviceId is a required field.
	"customVariables": [ # Custom floodlight variables.
	{ # A custom floodlight variable.
	"kind": "dfareporting#customFloodlightVariable", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable".
	"type": "A String", # The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags.
	"value": "A String", # The value of the custom floodlight variable. The length of string must not exceed 50 characters.
	},
	],
	"floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
	"value": 3.14, # The value of the conversion.
	"limitAdTracking": True or False, # Whether Limit Ad Tracking is enabled. When set to true, the conversion will be used for reporting but not targeting. This will prevent remarketing.
	"quantity": "A String", # The quantity of the conversion.
	"floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
	"mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId and encryptedUserIdCandidates[]. This or encryptedUserId or encryptedUserIdCandidates[] is a required field.
	},
	"errors": [ # A list of errors related to this conversion.
	{ # The error code and description for a conversion that failed to insert or update.
	"kind": "dfareporting#conversionError", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError".
	"code": "A String", # The error code.
	"message": "A String", # A description of the error.
	},
	],
	"kind": "dfareporting#conversionStatus", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus".
	},
	],
	"hasFailures": True or False, # Indicates that some or all conversions failed to insert.
	"kind": "dfareporting#conversionsBatchInsertResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertResponse".
	}</pre>
	</div>

	</body></html>