Zmień

Skrypty Google Ads obsługują ogólne mutacje dostępne w interfejsie Google Ads API. Większość operacji, które można wykonać w GoogleAdsService.mutate, można też wykonać w skryptach Google Ads, w tym tworzenie kampanii i zarządzanie nimi.

Ta funkcja umożliwia dostęp do tak dużej części interfejsu Google Ads API, że aby z niej korzystać, musisz znać podstawowe konwencje interfejsu Google Ads API. Możesz pominąć wiele aspektów, takich jak tokeny dewelopera i autoryzacja, ponieważ są one obsługiwane przez skrypty Google Ads, ale musisz utworzyć prawidłowe żądanie modyfikacji.

Oto kilka podstawowych zasobów dotyczących interfejsu REST interfejsu Google Ads API, z którymi warto się zapoznać, zanim przejdziesz do dalszej części tego przewodnika:

Podstawowy przykład

Aby zademonstrować tę funkcję, rozważmy ten podstawowy przykład, który tworzy budżet kampanii:

const budgetResult = AdsApp.mutate({
    campaignBudgetOperation: {
      create: {
        amountMicros: 10000000,
        explicitlyShared: false
      }
    }
  });

Wywołanie AdsApp.mutate przyjmuje obiekt JSON, który reprezentuje pojedynczy element MutateOperation. W tym obiekcie określasz, jaki rodzaj operacji wykonujesz – w tym przypadku campaignBudgetOperation. Następnie podaj create, remove lub oba parametry: update i updateMask. Konkretne pola w create i update zależą od konkretnego typu zasobu, na którym pracujesz.

Tworzenie operacji

Istnieje kilka strategii, które możesz zastosować, aby utworzyć prawidłową operację. Wracając do przykładu z budżetem kampanii, możesz zajrzeć do dokumentacji referencyjnej REST dotyczącej budżetu kampanii, aby zobaczyć listę wszystkich prawidłowych pól, a następnie wypełnić odpowiednie pola lub napisać w skrypcie niestandardowy kod JavaScript, który utworzy odpowiedni obiekt.

Możesz też spróbować utworzyć operację dynamicznie, korzystając z funkcji „Wypróbuj” w przypadku budżetu kampanii, która umożliwia dynamiczne tworzenie treści żądania przez wybieranie pól, które chcesz dodać. Następnie możesz wyodrębnić zawartość operacji z wygenerowanego wyniku i dodać ją do wywołania mutate po określeniu typu operacji.

Typy operacji

Utwórz

W operacji określ create, przekazując reprezentację obiektu zasobu, który chcesz utworzyć.

Przykład operacji create znajdziesz we fragmencie kodu podanym wcześniej.

Usuń

W operacji określ remove, podając nazwę zasobu, który chcesz usunąć, na przykład:

AdsApp.mutate({
    adGroupOperation: {
        remove: "customers/[CUSTOMER_ID]/adGroups/[AD_GROUP_ID]"
    }
});

Jeśli nie znasz nazwy zasobu encji, możesz ją pobrać za pomocą żądania Adsapp.search.

Zaktualizuj

W operacji określ update, przekazując obiekt z określoną nazwą zasobu, aby system mógł określić, który obiekt chcesz zaktualizować. Dodatkowo wypełnij wszystkie pola, których wartości chcesz zaktualizować, i określ updateMask, która wskazuje dokładnie, które pola planujesz zmienić w tym żądaniu. Nie podawaj nazwy zasobu w masce aktualizacji.

Przykład operacji update:

const campaignResult = AdsApp.mutate({
    campaignOperation: {
        update: {
            resourceName: "customers/[CUSTOMER_ID]/campaigns/[CAMPAIGN_ID]",
            status: "PAUSED",
            name: "[Paused] My campaign"
        },
        updateMask: "name,status"
    }
});

Obsługa wyników

Niezależnie od typu operacji zwracana wartość to MutateResult. Możesz użyć zwróconej nazwy zasobu, aby sprawdzić bieżący stan zasobu po zmianie i dowiedzieć się, czy operacja się powiodła lub jakie błędy wystąpiły.

Oto przykład, który pokazuje podstawowy proces sprawdzania wyniku i drukowania niektórych informacji w dziennikach:

const result = AdsApp.mutate( ... );
if (result.isSuccessful()) {
    console.log(`Resource ${result.getResourceName()} successfully mutated.`);
} else {
    console.log("Errors encountered:");
    for (const error of result.getErrorMessages()) {
        console.log(error);
    }
}

Wiele operacji

Skrypty Google Ads obsługują też modyfikowanie wielu operacji w jednym żądaniu za pomocą metody AdsApp.mutateAll. Możesz tworzyć encje, które są od siebie zależne, np. pełną hierarchię kampanii w jednym żądaniu. Opcjonalnie możesz sprawić, że cały zestaw operacji będzie niepodzielny, więc jeśli jedna z nich się nie powiedzie, żadna nie zostanie wykonana.

Zwracana wartość to tablica obiektów MutateResult, po jednym dla każdej podanej operacji i w tej samej kolejności co operacje początkowe.

Ta funkcja działa tak samo jak funkcja interfejsu Google Ads API, więc zapoznaj się z przewodnikiem Sprawdzone metody dotyczące interfejsu Google Ads API, aby uzyskać pełne wyjaśnienie tymczasowych identyfikatorów i inne informacje. Pamiętaj, że w przewodniku nazwy pól są zapisane w formacie snake_case, a w dokumentacji skryptów Google Ads – w formacie lowerCamelCase. Oba te przypadki są akceptowane w skryptach Google Ads, więc możesz skopiować kod bezpośrednio z tego przewodnika.

Aby wykonać wiele operacji w jednym żądaniu, zbierz wszystkie operacje w tablicy, a następnie wywołaj AdsApp.mutateAll. Wywołanie mutateAll przyjmuje tablicę operacji jako pierwszy argument i opcjonalny drugi argument opcji, w tym:

  • apiVersion: możesz podać niestandardową wersję interfejsu API, np. V26, jeśli chcesz używać wersji innej niż domyślna dla skryptów. Możesz używać dowolnej wersji dostępnej publicznie w danym momencie.
  • partialFailure: domyślna wartość tego pola to true. Jeśli ustawisz wartość true, prawidłowe operacje zostaną wykonane, a nieudane zwrócą błędy. Jeśli ustawisz wartość false, to w przypadku niepowodzenia dowolnej operacji żadne operacje nie zostaną wykonane, co sprawi, że ten zestaw operacji będzie niepodzielny.

Oto przykład z kilkoma operacjami, który tworzy budżet kampanii, kampanię i grupę reklam w żądaniu niepodzielnym.

const operations = [];
const customerId = 'INSERT_CUSTOMER_ID_HERE';
const budgetId = `customers/${customerId}/campaignBudgets/-1`;
const campaignId = `customers/${customerId}/campaigns/-2`;
operations.push({
    campaignBudgetOperation: {
      create: {
        resourceName: budgetId,
        amountMicros: 10000000,
        explicitlyShared: false
      }
    }
  });
operations.push({
    campaignOperation: {
      create: {
        resourceName: campaignId,
        name: 'New Campaign ' + new Date(),
        advertisingChannelType: 'SEARCH',
        manualCpc: {},
        campaignBudget: budgetId,
        advertisingChannelType: 'DISPLAY',
        networkSettings: {
          targetContentNetwork: true
        }
      }
    }
  });
operations.push({
    adGroupOperation: {
      create: {
        campaign: campaignId,
        name: 'New AdGroup ' + new Date(),
        optimizedTargetingEnabled: true
      }
    }
  });
const results = AdsApp.mutateAll(
    operations, {partialFailure: false});