User Lists

AI-generated Key Takeaways

• The provided content shows how to retrieve all user lists in AdsApp.

• It includes a function to log the number of members in each user list for both Search and Display campaigns.

• The content demonstrates how to open a specific user list by name.

• It also provides a function to retrieve the search campaigns that are being targeted by a given user list.

Retrieve all user lists

function getAllUserLists() {
  const userLists = AdsApp.userlists().get();
  console.log(`${userLists.totalNumEntities()} user lists found.`);
  return userLists;
}

Log the number of members in each user list

function logUserListMemberCount() {
  const userlists = AdsApp.userlists().get();
  for (const userlist of userlists) {
    console.log(`${userlist.getName()} has ${userlist.getSizeForSearch()} `
        + `members for Search campaigns and ${userlist.getSizeForDisplay()} `
        + `members for Display campaigns.`);
  }
}

Open a user list

function openUserList(name) {
  const userlists = AdsApp.userlists()
      .withCondition(`user_list.name = '${name}'`)
      .get();
  if (userlists.totalNumEntities() == 0) {
    throw new Error(`No user list with name '${name}' found.`);
  }
  const userlist = userlists.next();
  userlist.open();
}

Retrieve search campaigns targeted by a user list

function getSearchCampaignsTargetedByUserList(name) {
  const userlists = AdsApp.userlists()
      .withCondition(`user_list.name = '${name}'`)
      .get();
  if (userlists.totalNumEntities() == 0) {
    throw new Error(`No user list with name '${name}' found.`);
  }
  const userlist = userlists.next();
  const campaigns = userlist.targetedCampaigns().get();
  console.log(`Userlist '${name}' is targeting ${campaigns.totalNumEntities()} campaigns.`);
  return campaigns;
}