Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

Method: customers.uploadUserData

Uploads the given user data.

List of thrown errors: AuthenticationError AuthorizationError CollectionSizeError FieldError HeaderError InternalError MutateError OfflineUserDataJobError QuotaError RequestError UserDataError

HTTP request

POST https://googleads.googleapis.com/v12/customers/{customerId}:uploadUserData

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer for which to update the user data.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "operations": [
    {
      object (UserDataOperation)
    }
  ],

  // Union field metadata can be only one of the following:
  "customerMatchUserListMetadata": {
    object (CustomerMatchUserListMetadata)
  }
  // End of list of possible types for union field metadata.
}
Fields
operations[]

object (UserDataOperation)

Required. The list of operations to be done.
Union field metadata. Metadata of the request. metadata can be only one of the following:
customerMatchUserListMetadata

object (CustomerMatchUserListMetadata)

Metadata for data updates to a Customer Match user list.

Response body

If successful, the response body contains data with the following structure:

Response message for UserDataService.UploadUserData Uploads made through this service will not be visible under the 'Segment members' section for the Customer Match List in the Google Ads UI.

JSON representation 
{
  "uploadDateTime": string,
  "receivedOperationsCount": integer
}
Fields
uploadDateTime

string

The date time at which the request was received by API, formatted as "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01 12:32:45-08:00".
receivedOperationsCount

integer

Number of upload data operations received by API.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

UserDataOperation

Operation to be made for the UploadUserDataRequest.

JSON representation 
{

  // Union field operation can be only one of the following:
  "create": {
    object (UserData)
  },
  "remove": {
    object (UserData)
  }
  // End of list of possible types for union field operation.
}
Fields
Union field operation. Operation to be made for the UploadUserDataRequest. operation can be only one of the following:
create

object (UserData)

The list of user data to be appended to the user list.
remove

object (UserData)

The list of user data to be removed from the user list.