How to add User's email list to the UserLists, using the REST APIs.

605 views
Skip to first unread message

Kishan Virani

unread,
May 6, 2021, 2:01:56 AM5/6/21
to AdWords API and Google Ads API Forum
Hi There,

I've been trying to create the audience list with the CrmBasedUserList type and then add member's emails to the list. I've looked through the UserListOperation documentation under REST Interface documentation but didn't find anything promising. 

I've also looked at the "UserData" under the REST interface but could not find any resources which allow me to upload/associate the user emails to the remarketing UserList. 

Thanks, 
Kishan Virani

Google Ads API Forum Advisor Prod

unread,
May 6, 2021, 9:14:21 AM5/6/21
to kis...@customology.com.au, adwor...@googlegroups.com
Hello,

Thanks for reaching out. The OfflineUserDataJobService can be used to associate users with a user list. You can find REST specific documentation on this method here. As operations related to user lists may use other methods aside from standard REST methods, please see this page on using custom methods with the REST interface. All REST documentation for API services can be found here.

Regards,
Matt
Google Ads API Team

Google Logo
Matt
Google Ads API Team
 


ref:_00D1U1174p._5004Q2GKNlZ:ref

Kishan Virani

unread,
May 6, 2021, 9:33:55 PM5/6/21
to AdWords API and Google Ads API Forum
Hi Matt, 

1) I tried it with the OfflineUserDataJobService, but it didn't add users to the list yet. it's been 16h and it still shows me that the job is pending. how long does it take to add users through OfflineUserDataJobServices?

2) I could not find any documentation under the "other methods" which allows me to add users to the UserList. On the same page, I can see the method called "Mutate" to edit the "UserLists", but the userList object itself does not have users under it. "UserList Object".  It has no reference of updating usersList to add members to it. 

To note, I'm looking for Google Ads API alternative of Google Adwords API: https://adwords.google.com/api/adwords/rm/v201809/AdwordsUserListService MutateMember(). This API used to allow us to ADD or REMOVE members from the userLists. 

Thanks, 
Kishan Virani

Google Ads API Forum Advisor Prod

unread,
May 7, 2021, 2:25:58 AM5/7/21
to kis...@customology.com.au, adwor...@googlegroups.com
Hi Kishan,

Could you first confirm which API it is that you wish to use, is it the AdWords API or the Google Ads API?

I asked because the REST API/interface is more of a Google Ads API feature and the service (AdwordsUserListService) that you are specifying is an AdWords API service.

As for the changes to reflect regarding your audience uploads, this would vary depending on factors outside of our API team's scope. It can range from the 6-12 hours or even up to 48 hours as discussed here, under the Fix lists that have a constant “In progress” status section.

If you will be using the Google Ads API, you can refer to the rest of our customer match guide on what services to use and steps to perform in order to update your userlists. You can then refer to the REST API documentation on how to construct your requests.

Best regards,

Google Logo
Peter Laurence Napa Oliquino
Google Ads API Team
 


ref:_00D1U1174p._5004Q2GKNlZ:ref

Kishan Virani

unread,
May 9, 2021, 6:28:15 PM5/9/21
to AdWords API and Google Ads API Forum
Hi Peter, 

We were using the Google AdWords API to create and manage the remarketing Audience list. Since the Google AdWords APIs are being deprecated, we are trying to migrate our operations to the Google Ads REST API. 

The goal is to Create the UserList using the Google Ads API and then add users to the UserList. I've successfully created a new UserList using the Google Ads REST API(https://developers.google.com/google-ads/api/rest/reference/rest/v7/customers.userLists). The next task is to add Users to the list and that's where I cannot find any REST API documentation, which can allow me to add user's emails to the UserList. If you can help me find the documentation under REST API to add user's emails to the UserLists. 

Thanks, 
Kishan Virani

Google Ads API Forum Advisor Prod

unread,
May 10, 2021, 2:05:34 AM5/10/21
to kis...@customology.com.au, adwor...@googlegroups.com
Hi Kishan,

Thank you for your follow up.

We currently do not have a more concrete example using the REST interface. However, you can check out this example instead, and model your REST interface request based on the details from this example. 

In the example, the addUsersToCustomerMatchUserList method uses the OfflineUserDataJobService (customers.offlineUserDataJobs) to add the users to the userlist.

Kishan Virani

unread,
May 10, 2021, 6:45:33 PM5/10/21
to AdWords API and Google Ads API Forum
Hi Peter, 

Thank you for the response. 

Is it possible to get the timeframe of the REST API for the "AddUsersToUserList" functionality? Is the dedicated RESTAPI for this task in development or soon to be released? 


I've created two OfflineUsersDataJob with the dummy data using the Google Ads API. Both the jobs are on pending status for the last 3 days. do you have any timeframe for how long it takes to populate the UserLists with the user's emails? 
 
Thanks, 
Kishan Virani

Google Ads API Forum Advisor Prod

unread,
May 10, 2021, 11:47:19 PM5/10/21
to kis...@customology.com.au, adwor...@googlegroups.com
Hi Kishan,

I work with Peter and let me provide support to your concern.

With regard to the sample REST API for adding members to a user list, this guide may help you here. Let me know if you have question on the provided guide.

As for how long it will take to populate the UserLists with the user's emails, it takes 6 to 12 hours for a list to be populated with members, so you'll most likely see an "In Progress" status (on the Google Ads UI) if you upload to an audience list more frequently than once every 12 hours. However, it will sometimes take 48 hours according to this document. With this, I would suggest to wait for at most 2 days and if it is still not populated with the said period, then you may provide the complete request and response logs with request ID generated on your end to investigate and to address it.

Regards,
Google Logo
Ernie John Blanca Tacata
Google Ads API Team
 


ref:_00D1U1174p._5004Q2GKNlZ:ref

Kishan Virani

unread,
May 11, 2021, 5:41:47 PM5/11/21
to AdWords API and Google Ads API Forum
Hi Ernie, 

Thank you for your response. 

I'll try again with the offlineUserDataJobs. Let you know if something else comes up. 

Thanks, 
Kishan Virani

Reply all
Reply to author
Forward
0 new messages