Máscaras de campo

En la API de Google Ads, las actualizaciones se realizan mediante una máscara de campo. La máscara de campo enumera todos los campos que quieres cambiar con la actualización y los campos especificados que no estén en la máscara de campo se ignoran, incluso si se envían al servidor. Tú podrías crear una máscara de campo manualmente creando una Google\Protobuf\FieldMask: hacer que un array se complete con los nombres de todos los campos que quieres cambiar y, luego, lo asignaré al campo de ruta de acceso de la máscara de campo.

También puedes usar la utilidad de máscara de campo integrada (FieldMasks), que oculta muchos detalles específicos y te permite generar campos automáticamente a través de la supervisión de los cambios que realices en los campos de la entidad.

A continuación, le mostramos un ejemplo de cómo actualizar una campaña:

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

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

Este código primero crea un objeto Campaign y, luego, establece su nombre de recurso mediante ResourceNames, de modo que la API sepa qué campaña se está realizando se actualicen. status también se configura como PAUSED.

Luego, el código crea un objeto CampaignOperation y establece la creó una campaña en él. Después de eso, usa FieldMasks::allSetFieldsOf() para crear una máscara de campo para la campaña utilizando todos los campos modificados. Por último, pasa la máscara que se muestra al objeto de operación de campaña.

Ten en cuenta que FieldMasks::allSetFieldsOf es un método conveniente para FieldMasks::compare() Compara el objeto que se pasó con un objeto vacío de la misma clase. Para Por ejemplo, en el código anterior, podrías haber usado FieldMasks::compare(new Campaign(), $campaign) en lugar de allSetFieldsOf().

Actualiza los campos de mensaje y sus subcampos

Los campos MESSAGE pueden tener subcampos (como MaximizeConversions, que tiene tres: target_cpa_micros, cpc_bid_ceiling_micros y cpc_bid_floor_micros), o pueden no tener ninguno en absoluto (por ejemplo, ManualCpm).

Campos de mensaje sin subcampos definidos

Cuando actualices un campo MESSAGE que no esté definido con ningún subcampo, usa FieldMasks para generar una máscara de campo, como se describió anteriormente.

Campos de mensaje con subcampos definidos

Cuando se actualiza un campo MESSAGE definido con subcampos sin de forma explícita ninguno de los subcampos en ese mensaje, debes agregar cada uno de los subcampos MESSAGE mutables a FieldMask, similar a lo siguiente: en el ejemplo anterior, que creó una máscara de campo desde cero.

Un ejemplo común es actualizar la estrategia de ofertas de una campaña sin establecer ninguna de los campos en la nueva estrategia de ofertas. El siguiente código demuestra cómo actualizar una campaña para utilizar la Estrategia de ofertas de MaximizeConversions sin configurar ninguno de los subcampos de la estrategia de ofertas.

En este caso, usando los métodos allSetFieldsOf() y compare() de la FieldMasks no logra el objetivo previsto.

El siguiente código genera una máscara de campo que incluye maximize_conversions. Sin embargo, la API de Google Ads no permite este comportamiento para evitar borrar campos accidentalmente y produce un 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]);

El siguiente código demuestra cómo actualizar correctamente una campaña para usar la Estrategia de ofertas de MaximizeConversions sin configurar ninguno de sus subcampos.

// 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);

Borrando campos

Algunos campos se pueden borrar de forma explícita. Al igual que en el ejemplo anterior, debes agregar explícitamente estos campos a la máscara de campo. Por ejemplo, supongamos que tienes un campaña que usa una estrategia de ofertas MaximizeConversions y que la El campo target_cpa_micros se configura con un valor mayor que 0.

Se ejecuta el siguiente código: Sin embargo, la función maximize_conversions.target_cpa_micros no se agregará a la máscara de campo, por lo que no se realizarán cambios en la Campo target_cpa_micros:

// 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]);

En el siguiente código, se muestra cómo borrar correctamente target_cpa_micros en la estrategia de ofertas 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);

Ten en cuenta que la sección “incorrecto” el código funciona según lo previsto para los campos que están definidos como optional en protocol buffers de la API de Google Ads. Sin embargo, como el target_cpa_micros no es un campo optional, el campo "incorrecto" código no actualiza la de oferta para borrar el campo target_cpa.