DCM/DFA Reporting And Trafficking API . conversions

batchinsert(profileId, body)

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.
        "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.
        "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.
        "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 NO_COOKIE_MATCH_FOUND 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 and mobileDeviceId. This or encryptedUserId or mobileDeviceId is a required field.
          "A String",
        ],
      },
    ],
    "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 or encryptedUserIdCandidates[] is encrypted. This is a required field if encryptedUserId or encryptedUserIdCandidates[] 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 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.
          "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.
          "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.
          "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.
          "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 NO_COOKIE_MATCH_FOUND 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 and mobileDeviceId. This or encryptedUserId or mobileDeviceId is a required field.
            "A String",
          ],
        },
        "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".
  }

batchupdate(profileId, body)

Updates existing conversions.

Args:
  profileId: string, User profile ID associated with this request. (required)
  body: object, The request body. (required)
    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.
        "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.
        "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.
        "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.
        "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 NO_COOKIE_MATCH_FOUND 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 and mobileDeviceId. This or encryptedUserId or mobileDeviceId is a required field.
          "A String",
        ],
      },
    ],
    "kind": "dfareporting#conversionsBatchUpdateRequest", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateRequest".
    "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:

    { # Update Conversions Response.
    "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.
          "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.
          "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.
          "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.
          "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 NO_COOKIE_MATCH_FOUND 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 and mobileDeviceId. This or encryptedUserId or mobileDeviceId is a required field.
            "A String",
          ],
        },
        "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 update.
    "kind": "dfareporting#conversionsBatchUpdateResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionsBatchUpdateResponse".
  }