Maski w polu

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órych nie ma w masce pola, są ignorowane, nawet jeśli zostaną wysłane na serwer. Maskę pola możesz utworzyć ręcznie, tworząc FieldMask (Google\Protobuf\FieldMask), czyli tablicę wypełnioną nazwami wszystkich pól, które chcesz zmienić, a następnie przypisując tę tablicę do pola paths 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 sprawdzanie zmian wprowadzanych w polach elementu.

Oto przykład aktualizacji kampanii:

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

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

Ten kod najpierw tworzy obiekt Campaign, a potem ustawia jego nazwę zasobu za pomocą funkcji ResourceNames, aby interfejs API wiedział, która kampania jest aktualizowana. status jest też ustawiony na CampaignStatus::PAUSED.

Następnie kod tworzy obiekt CampaignOperation i ustawia na nim utworzoną wcześniej kampanię. Następnie używa polecenia FieldMasks::allSetFieldsOf() do utworzenia maski pola kampanii przez wyliczenie wszystkich zmodyfikowanych 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 możesz użyć FieldMasks::compare(new Campaign(), $campaign) zamiast FieldMasks::allSetFieldsOf($campaign).

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

Pola MESSAGE mogą mieć pola podrzędne (np. MaximizeConversions, które zawiera pola podrzędne takie jak 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 FieldMasks, aby wygenerować maskę pola, jak opisano wcześniej.

Pola wiadomości ze zdefiniowanymi podpola

Podczas aktualizowania pola MESSAGE zdefiniowanego za pomocą pól podrzędnych bez wyraźnego ustawiania żadnego z tych pól w wiadomości musisz ręcznie dodać każde z zmiennych pól podrzędnych MESSAGE do pola 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 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, i wyświetla 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 includes 'maximize_conversions',
// which produces 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 results in a
// FieldMaskError.FIELD_HAS_SUBFIELDS error because empty MESSAGE fields cannot
// be included in a field mask.
$campaignServiceClient = $googleAdsClient->getCampaignServiceClient();
$response = $campaignServiceClient->mutateCampaigns(
    MutateCampaignsRequest::build($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 the mutable
// subfield 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 sets 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:
// https://developers.google.com/google-ads/api/docs/campaigns/bidding/assign-strategies
$fieldMask->getPaths()[] = '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);

Wyczyść pola

Niektóre pola można wyraźnie wyczyścić. Podobnie jak w poprzednim przykładzie musisz wyraźnie dodać te pola do maski pola, ponieważ FieldMasks ignoruje pola skalarne Proto3 ustawione na wartości domyślne (np. 0, false lub ""). 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.

Ten 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_micros' => 0
    ]),
    'status' => CampaignStatusEnum\CampaignStatus::PAUSED
]);

// Constructs an operation, using the FieldMasks' allSetFieldsOf utility to
// derive the update mask. However, the field mask does 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 succeeds, but does 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(
    MutateCampaignsRequest::build($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
// clears this field from the bidding strategy without impacting any other
// fields on the bidding strategy.
$fieldMask = FieldMasks::allSetFieldsOf($campaign);
$fieldMask->getPaths()[] = '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 ustawienie wartości domyślnej działa zgodnie z przeznaczeniem w przypadku pól zdefiniowanych jako optional w buforach protokołu interfejsu Google Ads API. Jednak ponieważ target_cpa_micros nie jest polem optional, ustawienie go na 0 bez wyraźnego dodania ścieżki do maski pola nie powoduje zaktualizowania strategii ustalania stawek w celu wyczyszczenia target_cpa_micros.