Labels
Stay organized with collections
Save and categorize content based on your preferences.
Get all labels from a user's account
function getAllLabels() {
const labelIterator = AdsApp.labels().get();
console.log(`Total labels found: ${labelIterator.totalNumEntities()}`);
return labelIterator;
}
Get a label by name
function getLabelByName(name) {
const labelIterator = AdsApp.labels()
.withCondition(`label.name = "${name}"`)
.get();
if (labelIterator.hasNext()) {
const label = labelIterator.next();
console.log(`Name: ${label.getName()}`);
console.log(`Description: ${label.getDescription()}`);
console.log(`Color: ${label.getColor()}`);
console.log(`Number of campaigns: ${label.campaigns().get().totalNumEntities()}`);
console.log(`Number of ad groups: ${label.adGroups().get().totalNumEntities()}`);
console.log(`Number of ads: ${label.ads().get().totalNumEntities()}`);
console.log(`Number of keywords: ${label.keywords().get().totalNumEntities()}`);
return label;
}
return null;
}
Apply a label to a campaign
function applyLabel(labelName, campaignName) {
// Retrieve a campaign, and apply a label to it. Applying labels to other
// object types is similar.
const campaignIterator = AdsApp.campaigns()
.withCondition(`campaign.name = "${campaignName}"`)
.get();
if (campaignIterator.hasNext()) {
const campaign = campaignIterator.next();
campaign.applyLabel(labelName);
}
}
Remove a label from a campaign
function removeLabel(labelName, campaignName) {
// Removing labels from other object types is similar.
const campaignIterator = AdsApp.campaigns()
.withCondition(`campaign.name = "${campaignName}"`)
.get();
if (campaignIterator.hasNext()) {
const campaign = campaignIterator.next();
campaign.removeLabel(labelName);
}
}
Delete a label from the user's account
function deleteLabel(labelName) {
const labelIterator = AdsApp.labels()
.withCondition(`label.name = "${labelName}"`)
.get();
if (labelIterator.hasNext()) {
const label = labelIterator.next();
label.remove();
}
}
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-03-14 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
{"lastModified": "Last updated 2022-03-14 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2022-03-14 UTC."]]