Skriptbeispiele für die Verwaltung von Schlüsselwörtern

Die folgenden Abschnitte zeigen Beispiele für Skripts, die verschiedene Aktionen für Schlüsselwörter ausführen.

Hinzufügen von Schlüsselwörtern

Rufen Sie zum Hinzufügen eines Schlüsselworts (Keyword) zuerst die Anzeigengruppe ab, der das Schlüsselwort (Keyword) hinzugefügt werden soll. Verwenden Sie das AdGroupSelector-Objekt , um die Anzeigengruppe auszuwählen. Die Verwendung der withIds Methode bietet eine bessere Leistung als die Übergabe des Namens der Anzeigengruppe in der withCondition Methode.

Rufen Sie als Nächstes die newKeywordBuilder-Methode der Anzeigengruppe auf, um einen Generator zu erhalten, mit dem Sie die Eigenschaften des Schlüsselworts (Keyword) angeben. Die einzige Eigenschaft, die Sie angeben müssen, ist der Text des Schlüsselworts (keyword) (siehe withText Methode). Der Text sollte die Match-Option enthalten (Anführungszeichen für den Ausdrucks-Match-Typ, eckige Klammern für den genauen Match-Typ, nichts für den weiten Match-Option).

Wenn Sie keinen CPC-Wert angeben, wird standardmäßig der CPC-Wert der Anzeigengruppe verwendet. Standardmäßig ist der Status des Schlüsselworts) aktiviert.

Durch Aufrufen der Builder-Methode build wird das Schlüsselwort (Keyword) asynchron erstellt. Skripts fügt das Schlüsselwort (Keyword) zu einem Zeitpunkt hinzu, bevor das Skript beendet wird oder wenn Sie eine der Methoden des Buildvorgangs aufrufen. Informationen zu diesem Prozess finden Sie unter Was ist ein Builder?

function main() {
    // The ID of the ad group to add the keywords to.
    // IDs in Scripts are string integers.
    var adGroupId = 'AD GROUP ID GOES HERE';  
    var adGroup = getAdGroup(adGroupId);

    // Keywords to add. Update as appropriate.
    var keywords = [];
    keywords.push({
        text : "keyword 1",
        cpc : 1.25,
        finalUrl : 'http://www.example.com'
    });
    keywords.push({
        text : "keyword 2",
        cpc : 1.5,
        finalUrl : 'http://www.example.com'
    });

    var operations = [];

    if (adGroup != null)
    {
        for (var keyword of keywords) {
            var operation = addKeyword(
                adGroup, 
                keyword.text, 
                keyword.cpc, 
                keyword.finalUrl);
            operations.push(operation);
        }
    }
    else {
        Logger.log("Unable to retrieve ad group, " + adGroupId);
    }

    checkBuildStatus(operations, keywords);
}

// Get the ad group using its ID.
function getAdGroup(id) {
    var iterator = AdsApp.adGroups()
        .withIds([id])
        .get();

    // Return the ad group if it exists; otherwise, null.
    if (iterator.hasNext()) {
        return iterator.next();
    }
    else {
        return null;
    }
}

// Add the keyword to the specified ad group.
function addKeyword(adGroup, text, cpc, finalUrl) {

    return adGroup.newKeywordBuilder()
        .withText(text)
        .withCpc(cpc)
        .withFinalUrl(finalUrl)
        .build();
}

// Check the keyword's build status.
function checkBuildStatus(operations, keywords) {

    for (var i = 0; i < operations.length; i++) {
        if (!operations[i].isSuccessful()) {
            for (var error of operations[i].getErrors()) {
                Logger.log(`Failed to add, ${keywords[i].text}. Error: ${error}`);
            }
        }
    }
}

Anhalten eines Schlüsselworts (keyword)

Wenn Sie ein Schlüsselwort (keyword) hinzufügen, ist sein Status standardmäßig aktiviert. Wenn Sie das Schlüsselwort (keyword) anhalten möchten, rufen Sie die Methode des Schlüsselworts (keyword) aufpause. Um den Status des Schlüsselworts (Keyword) zu ermitteln, rufen Sie die Keywords isEnabled und isPaused Methoden auf.

function main() {
    var campaignName = 'CAMPAIGN NAME GOES HERE';
    var adGroupName = 'AD GROUP NAME GOES HERE';
    var keywordText = 'KEYWORD TEXT GOES HERE';

    var iterator = AdsApp.keywords()
        .withCondition(`Text = '${keywordText}'`)
        .withCondition(`AdGroupName = '${adGroupName}'`)
        .withCondition(`CampaignName = '${campaignName}'`)
        .get();

    while (iterator.hasNext()) {
        var keyword = iterator.next();
        keyword.pause();
    }
}

Abrufen aller Keywords in einer Anzeigengruppe

Um alle Keywords in einer Anzeigengruppe abzurufen, rufen Sie zuerst die Methode des AdsApp-Objektskeywords auf, um den Selektor abzurufen. Verwenden Sie die withCondition Methode, um die Anzeigengruppe und Kampagne anzugeben. Rufen Sie dann die Selektormethode get auf, um einen Iterator abzurufen, mit dem Sie die Liste der Schlüsselwörter durchlaufen können. Um die Anzahl der Schlüsselwörter im Iterator zu bestimmen, rufen Sie die Methode des Iterators auf totalNumEntities .

Wenn Sie Zugriff auf die Schlüsselwort(keyword)-IDs haben, verwenden Sie stattdessen diese. Die Verwendung von IDs zum Abrufen von Entitäten bietet eine bessere Leistung. Anstatt die withCondition Filtermethode zu verwenden, verwenden Sie die withIds Methode. Beispiel: withIds(['12345']). Die Anzahl der Entitäten, die Sie mithilfe von IDs abrufen können, ist begrenzt.

function main() {
    var campaignName = 'CAMPAIGN NAME GOES HERE';
    var adGroupName = 'AD GROUP NAME GOES HERE';

    var iterator = AdsApp.keywords()
        .withCondition(`AdGroupName = '${adGroupName}'`)
        .withCondition(`CampaignName = '${campaignName}'`)
        .get();
        
    while (iterator.hasNext()) {
        var keyword = iterator.next();
    }
}

Abrufen aller Keywords in einem Konto

Die Anzahl der Keywords, die Skripts für ein Konto zurückgeben können, ist begrenzt. Der Grenzwert ist nicht definiert und kann sich ändern. Das folgende Beispiel zeigt, wie Sie Fälle handhaben können, in denen ein Konto zu viele Schlüsselwörter enthält. Im Beispiel wird versucht, alle Schlüsselwörter zuerst auf Kontoebene abzurufen. Wenn dies aufgrund des Fehlers "Es sind zu viele Entitäten vorhanden" fehlschlägt, wird versucht, mehrere Aufrufe zum Abrufen von Schlüsselwörtern nach Kampagne durchzuführen, da es in der Regel weniger Entitäten auf Kampagnenebene gibt.

Informationen zur Verwendung des Schlüsselworts yield) finden Sie unter Verwenden des Schlüsselworts (Schlüsselwort (Schlüsselwort) yield beim Abrufen großer Mengen von Entitäten.

function* getEntities() {
    const applyConditions = _ => _
        .withCondition('CampaignStatus = ENABLED')
        .withCondition('AdGroupStatus = ENABLED')
        .withCondition('Status = ENABLED')
        .withCondition("CombinedApprovalStatus = DISAPPROVED");

    try {
        // Get the account's keywords. 
        const keywords = applyConditions(AdsApp.keywords()).get();

        while (keywords.hasNext()) {
            yield keywords.next();
        }
    } catch (e) {
        if (!e.message.startsWith('There are too many entities')) {
            throw e;
        }

        // If there are too many keywords at the account level,
        // get keywords by campaigns under the account.
        const campaigns = AdsApp.campaigns().get();

        while (campaigns.hasNext()) {
            const campaign = campaigns.next();

            const keywords = applyConditions(campaign.keywords()).get();

            while (keywords.hasNext()) {
                yield keywords.next();
            }
        }
    }
}

Abrufen der Performance-Daten eines Schlüsselworts (keyword)

Um die Performance-Kennzahlen eines Schlüsselworts (keyword) abzurufen, rufen Sie die getStats-Methode des Schlüsselworts (keyword) auf. Wenn Sie das Schlüsselwort (Keyword) erhalten, müssen Sie den Datumsbereich der gewünschten Metrikdaten angeben. Sie können den Datumsbereich mithilfe eines vordefinierten Literals, z. B. LAST_MONTH oder HEUTE, oder eines Start- und Enddatums angeben. Verwenden Sie zum Angeben des Datumsbereichs eine der MethodenforDateRange, wenn Sie das Schlüsselwort (keyword) auswählen (siehe KeywordSelector).

Eine Liste der Metriken, auf die Sie zugreifen können, finden Sie im Objekt "Statistiken ".

function main() {
    var campaignName = 'CAMPAIGN NAME GOES HERE';
    var adGroupName = 'AD GROUP NAME GOES HERE';
    var keywordText = 'KEYWORD TEXT GOES HERE';

    // Get the keyword. You need to specify the date range of the
    // performance data you want to get.
    var iterator = AdsApp.keywords()
        .forDateRange('LAST_WEEK')
        .withCondition(`Text = '${keywordText}'`)
        .withCondition(`AdGroupName = '${adGroupName}'`)
        .withCondition(`CampaignName = '${campaignName}'`)
        .get();

    // If the keyword is found, log some metrics.
    if (iterator.hasNext()) {
        var keyword = iterator.next();
        var metrics = keyword.getStats(); // Gets the performance metrics.
    }
}

Aktualisieren Sie den Gebotswert eines Schlüsselworts (Keyword).

Ein Beispiel, das zeigt, wie der Gebotswert eines Schlüsselworts (Keyword) aktualisiert wird, finden Sie unter Aufrufen von Google-Diensten.