Maski terenowe

W interfejsie Google Ads API aktualizacje są przeprowadzane przy użyciu maski pola. Maska pola zawiera listę wszystkich pól, które chcesz zmienić w ramach aktualizacji. Wszystkie określone pola, które nie znajdują się w masce pola, są ignorowane, nawet jeśli zostaną wysłane na serwer. Maskę pola możesz utworzyć ręcznie, tworząc Google\Protobuf\FieldMask, tworząc tablicę wypełnioną nazwami wszystkich pól, które chcesz zmienić, a następnie przypisując ją do pola ścieżki maski pola.

Możesz też użyć naszego wbudowanego narzędzia do maskowania pól (FieldMasks), które ukrywa wiele szczegółów i umożliwia automatyczne generowanie masek pól przez monitorowanie zmian wprowadzanych w polach elementu.

Oto przykład aktualizacji kampanii:

    $campaign = new Campaign([
        'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
        'status' => CampaignStatus::PAUSED
    ]);

    $campaignOperation = new CampaignOperation();
    $campaignOperation->setUpdate($campaign);
    $campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign));

Ten kod najpierw tworzy obiekt Campaign, a następnie ustawia jego nazwę zasobu za pomocą funkcji ResourceNames, aby interfejs API wiedział, która kampania jest aktualizowana. status ma też wartość PAUSED.

Następnie kod tworzy obiekt CampaignOperation i przypisuje do niego utworzoną wcześniej kampanię. Następnie używa FieldMasks::allSetFieldsOf() do utworzenia maski pola dla kampanii, korzystając ze wszystkich zmienionych pól. Na koniec przekazuje zwróconą maskę do obiektu operacji na kampanii.

Pamiętaj, że FieldMasks::allSetFieldsOf to wygodna metoda dla FieldMasks::compare(). Porównuje przekazany obiekt z pustym obiektem tej samej klasy. Na przykład w poprzednim kodzie zamiast allSetFieldsOf() można było użyć FieldMasks::compare(new Campaign(), $campaign).

Aktualizowanie pól wiadomości i ich pól podrzędnych

Pola MESSAGE mogą mieć pola podrzędne (np. MaximizeConversions, które ma 3 pola: target_cpa_micros, cpc_bid_ceiling_micros i cpc_bid_floor_micros) lub nie mieć ich wcale (np. ManualCpm).

Pola wiadomości bez zdefiniowanych podpól

Podczas aktualizowania pola MESSAGE, które nie jest zdefiniowane za pomocą żadnych pól podrzędnych, użyj znaku FieldMasks, aby wygenerować maskę pola, jak opisano wcześniej.

Pola wiadomości ze zdefiniowanymi podpola

Aktualizując pole MESSAGE z podpolami bez wyraźnego ustawiania żadnego z nich w danej wiadomości, musisz ręcznie dodać każde z zmiennych podpól MESSAGE do FieldMask, podobnie jak w poprzednim przykładzie, w którym maska pola została utworzona od zera.

Jednym z częstych przykładów jest aktualizacja strategii ustalania stawek w kampanii bez ustawiania żadnych pól w nowej strategii ustalania stawek. Poniższy kod pokazuje, jak zaktualizować kampanię, aby korzystała ze strategii ustalania stawek MaximizeConversions bez ustawiania żadnych pól podrzędnych w tej strategii.

W takim przypadku użycie metod allSetFieldsOf() i compare() z interfejsu FieldMasks nie przyniesie zamierzonego efektu.

Poniższy kod generuje maskę pola, która zawiera maximize_conversions. Interfejs Google Ads API nie zezwala jednak na takie działanie, aby zapobiec przypadkowemu czyszczeniu pól. W takim przypadku zwraca błąd FieldMaskError.FIELD_HAS_SUBFIELDS.

// Creates a campaign with the proper resource name and an empty
// MaximizeConversions field.
$campaign = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
    'maximize_conversions' => new MaximizeConversions()
]);

// Constructs an operation, using the FieldMasks' allSetFieldsOf utility to
// derive the update mask. The field mask will include 'maximize_conversions`,
// which will produce a FieldMaskError.FIELD_HAS_SUBFIELDS error.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign));

// Sends the operation in a mutate request that will result in a
// FieldMaskError.FIELD_HAS_SUBFIELDS error because empty MESSAGE fields cannot
// be included in a field mask.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns($customerId, [$campaignOperation]);

Poniższy kod pokazuje, jak prawidłowo zaktualizować kampanię, aby korzystała ze strategii ustalania stawek MaximizeConversions bez ustawiania żadnych jej pól podrzędnych.

// Creates a Campaign object with the proper resource name.
$campaign = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId)
]);

// Creates a field mask from the existing campaign and adds all of the mutable
// fields (only one in this case) on the MaximizeConversions bidding strategy to
// the field mask. Because this field is included in the field mask but
// excluded from the campaign object, the Google Ads API will set the campaign's
// bidding strategy to a MaximizeConversions object without any of its subfields
// set.
fieldMask = FieldMasks::allSetFieldsOf($campaign);
// Only include 'maximize_conversions.target_cpa_micros' in the field mask
// as it is the only mutable subfield on MaximizeConversions when used as a
// standard bidding strategy.
//
// Learn more about standard and portfolio bidding strategies here:
// https://developers.google.com/google-ads/api/docs/campaigns/bidding/assign-strategies
$fieldMask->setPaths(array_merge(
    iterator_to_array($fieldMask->getPaths()->getIterator()),
    ['maximize_conversions.target_cpa_micros']
));

// Creates an operation to update the campaign with the specified fields.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask($fieldMask);

Czyszczenie pól

Niektóre pola można wyczyścić w sposób jawny. Podobnie jak w poprzednim przykładzie musisz wyraźnie dodać te pola do maski pola. Załóżmy na przykład, że masz kampanię, która korzysta ze strategii ustalania stawek MaximizeConversions, a pole target_cpa_micros ma wartość większą niż 0.

Poniższy kod zostanie uruchomiony, ale maximize_conversions.target_cpa_micros nie zostanie dodany do maski pola, więc w polu target_cpa_micros nie zostaną wprowadzone żadne zmiany:

// Creates a campaign with the proper resource name and a MaximizeConversions
// object with target_cpa_micros set to 0.
$campaign = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId),
    'maximize_conversions' => new MaximizeConversions(['target_cpa' => 0]),
    'status' => CampaignStatus::PAUSED
]);

// Constructs an operation, using the FieldMasks' allSetFieldsOf utility to
// derive the update mask. However, the field mask will NOT include
// 'maximize_conversions.target_cpa_micros'.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask(FieldMasks::allSetFieldsOf($campaign));

// Sends the operation in a mutate request that will succeed but will NOT update
// the 'target_cpa_micros' field because
// 'maximize_conversions.target_cpa_micros' was not included in the field mask.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns($customerId, [$campaignOperation]);

Poniższy kod pokazuje, jak prawidłowo wyczyścić pole target_cpa_micros w strategii ustalania stawek MaximizeConversions.

// Creates a Campaign object with the proper resource name.
$campaign = new Campaign([
    'resource_name' => ResourceNames::forCampaign($customerId, $campaignId)
]);

// Constructs a field mask from the existing campaign and adds the
// 'maximize_conversions.target_cpa_micros' field to the field mask, which will
// clear this field from the bidding strategy without impacting any other fields
// on the bidding strategy.
$fieldMask = FieldMasks::allSetFieldsOf($campaign);
$fieldMask->setPaths(array_merge(
    iterator_to_array($fieldMask->getPaths()->getIterator()),
    ['maximize_conversions.target_cpa_micros']
));

// Creates an operation to update the campaign with the specified field.
$campaignOperation = new CampaignOperation();
$campaignOperation->setUpdate($campaign);
$campaignOperation->setUpdateMask($fieldMask);

Pamiętaj, że „nieprawidłowy” kod działa zgodnie z przeznaczeniem w przypadku pól zdefiniowanych jako optional w interfejsie Google Ads API protocol buffers. Ponieważ jednak pole target_cpa_micros nie jest polem optional, „nieprawidłowy” kod nie aktualizuje strategii ustalania stawek, aby wyczyścić pole target_cpa.