batchinsert(profileId, body=None, x__xgafv=None)

Inserts conversions.

Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body.
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.
"childDirectedTreatment": True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance.
"customVariables": [ # Custom floodlight variables. This field may only be used when calling batchinsert; it is not supported by batchupdate.
{ # A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate.
"kind": "A String", # 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 100 characters.
},
],
"dclid": "A String", # The display click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid is a required field.
"encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], matchId, mobileDeviceId, gclid and dclid. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid or dclid is a required field.
"encryptedUserIdCandidates": [ # A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId, gclid and dclid. This or encryptedUserId or matchId or mobileDeviceId or gclid or dclid is a required field.
"A String",
],
"floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
"floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
"gclid": "A String", # The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or dclid is a required field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#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.
"matchId": "A String", # The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId or gclid or dclid is a required field.
"mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or gclid or dclid is a required field.
"nonPersonalizedAd": True or False, # Whether the conversion was for a non personalized 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.
"quantity": "A String", # The quantity of the conversion.
"timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
"treatmentForUnderage": True or False, # Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR).
"value": 3.14, # The value of the conversion.
},
],
"encryptionInfo": { # A description of how user IDs are encrypted. # Describes how encryptedUserId or encryptedUserIdCandidates[] is encrypted. This is a required field if encryptedUserId or encryptedUserIdCandidates[] is used.
"encryptionEntityId": "A String", # The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.
"encryptionEntityType": "A String", # The encryption entity type. 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.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo".
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertRequest".
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Insert Conversions Response.
"hasFailures": True or False, # Indicates that some or all conversions failed to insert.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchInsertResponse".
"status": [ # The insert status of each conversion. Statuses are 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.
"childDirectedTreatment": True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance.
"customVariables": [ # Custom floodlight variables. This field may only be used when calling batchinsert; it is not supported by batchupdate.
{ # A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate.
"kind": "A String", # 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 100 characters.
},
],
"dclid": "A String", # The display click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid is a required field.
"encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], matchId, mobileDeviceId, gclid and dclid. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid or dclid is a required field.
"encryptedUserIdCandidates": [ # A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId, gclid and dclid. This or encryptedUserId or matchId or mobileDeviceId or gclid or dclid is a required field.
"A String",
],
"floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
"floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
"gclid": "A String", # The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or dclid is a required field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#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.
"matchId": "A String", # The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId or gclid or dclid is a required field.
"mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or gclid or dclid is a required field.
"nonPersonalizedAd": True or False, # Whether the conversion was for a non personalized 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.
"quantity": "A String", # The quantity of the conversion.
"timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
"treatmentForUnderage": True or False, # Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR).
"value": 3.14, # The value of the conversion.
},
"errors": [ # A list of errors related to this conversion.
{ # The error code and description for a conversion that failed to insert or update.
"code": "A String", # The error code.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError".
"message": "A String", # A description of the error.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus".
},
],
}

batchupdate(profileId, body=None, x__xgafv=None)

Updates existing conversions.

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

{ # Update Conversions Request.
"conversions": [ # The set of conversions to update.
{ # A Conversion represents when a user successfully performs a desired action after seeing an ad.
"childDirectedTreatment": True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance.
"customVariables": [ # Custom floodlight variables. This field may only be used when calling batchinsert; it is not supported by batchupdate.
{ # A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate.
"kind": "A String", # 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 100 characters.
},
],
"dclid": "A String", # The display click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid is a required field.
"encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], matchId, mobileDeviceId, gclid and dclid. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid or dclid is a required field.
"encryptedUserIdCandidates": [ # A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId, gclid and dclid. This or encryptedUserId or matchId or mobileDeviceId or gclid or dclid is a required field.
"A String",
],
"floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
"floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
"gclid": "A String", # The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or dclid is a required field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#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.
"matchId": "A String", # The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId or gclid or dclid is a required field.
"mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or gclid or dclid is a required field.
"nonPersonalizedAd": True or False, # Whether the conversion was for a non personalized 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.
"quantity": "A String", # The quantity of the conversion.
"timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
"treatmentForUnderage": True or False, # Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR).
"value": 3.14, # The value of the conversion.
},
],
"encryptionInfo": { # A description of how user IDs are encrypted. # Describes how encryptedUserId is encrypted. This is a required field if encryptedUserId is used.
"encryptionEntityId": "A String", # The encryption entity ID. This should match the encryption configuration for ad serving or Data Transfer.
"encryptionEntityType": "A String", # The encryption entity type. 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.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo".
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateRequest".
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Update Conversions Response.
"hasFailures": True or False, # Indicates that some or all conversions failed to update.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateResponse".
"status": [ # The update status of each conversion. Statuses are returned in the same order that conversions are updated.
{ # 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.
"childDirectedTreatment": True or False, # Whether this particular request may come from a user under the age of 13, under COPPA compliance.
"customVariables": [ # Custom floodlight variables. This field may only be used when calling batchinsert; it is not supported by batchupdate.
{ # A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate.
"kind": "A String", # 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 100 characters.
},
],
"dclid": "A String", # The display click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and gclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid is a required field.
"encryptedUserId": "A String", # The alphanumeric encrypted user ID. When set, encryptionInfo should also be specified. This field is mutually exclusive with encryptedUserIdCandidates[], matchId, mobileDeviceId, gclid and dclid. This or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid or dclid is a required field.
"encryptedUserIdCandidates": [ # A list of the alphanumeric encrypted user IDs. Any user ID with exposure prior to the conversion timestamp will be used in the inserted conversion. If no such user ID is found then the conversion will be rejected with INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. This field may only be used when calling batchinsert; it is not supported by batchupdate. This field is mutually exclusive with encryptedUserId, matchId, mobileDeviceId, gclid and dclid. This or encryptedUserId or matchId or mobileDeviceId or gclid or dclid is a required field.
"A String",
],
"floodlightActivityId": "A String", # Floodlight Activity ID of this conversion. This is a required field.
"floodlightConfigurationId": "A String", # Floodlight Configuration ID of this conversion. This is a required field.
"gclid": "A String", # The Google click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or dclid is a required field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#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.
"matchId": "A String", # The match ID field. A match ID is your own first-party identifier that has been synced with Google using the match ID feature in Floodlight. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[],mobileDeviceId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or mobileDeviceId or gclid or dclid is a required field.
"mobileDeviceId": "A String", # The mobile device ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, gclid and dclid. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or gclid or dclid is a required field.
"nonPersonalizedAd": True or False, # Whether the conversion was for a non personalized 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.
"quantity": "A String", # The quantity of the conversion.
"timestampMicros": "A String", # The timestamp of conversion, in Unix epoch micros. This is a required field.
"treatmentForUnderage": True or False, # Whether this particular request may come from a user under the age of 16 (may differ by country), under compliance with the European Union's General Data Protection Regulation (GDPR).
"value": 3.14, # The value of the conversion.
},
"errors": [ # A list of errors related to this conversion.
{ # The error code and description for a conversion that failed to insert or update.
"code": "A String", # The error code.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError".
"message": "A String", # A description of the error.
},
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionStatus".
},
],
}

Campaign Manager 360 API . conversions

Instance Methods

Method Details