Cambia e inspecciona objetos

Como se explica en la guía de estructura de API, cada recurso de nivel superior de la API de Google Ads tiene un servicio específico de tipo de recurso que admite lo siguiente:

  • Modificar instancias del recurso
  • Recupera una sola instancia del recurso para su inspección

En esta guía, se usará CampaignService para demostrar la modificación e inspección de objetos Campaign, pero los mismos conceptos se aplican a todos los demás servicios específicos de un tipo de recurso.

Cambiar objetos

Cada servicio específico de tipo de recurso tendrá un método mutate que acepta una solicitud de mutación. Esta solicitud consta de lo siguiente:

  • Un customerId
  • Un conjunto de operaciones
  • Una configuración de tipo de contenido de respuesta que determina si se debe mostrar el recurso mutable o solo el nombre del recurso después de la mutación.

Por ejemplo, el método MutateCampaigns de CampaignService acepta una MutateCampaignsRequest que consta de los siguientes elementos:

  • Un customerId
  • Una colección de objetos CampaignOperation
  • El campo response_content_type indica el tipo de respuesta preferida.

Operaciones

Un objeto de operación, como CampaignOperation, te permite especificar la acción que deseas realizar en un solo recurso mediante la configuración de su campo operation. Este campo es uno de campos, que consta de los siguientes atributos cuyo tipo es el tipo de recurso:

create
Crea una instancia nueva del recurso.
update
Actualiza el recurso para que coincida con los atributos del recurso update. Cuando se configura este campo, también debes configurar el update_mask de la operación, que le indica a la API de Google Ads qué atributos debe modificar durante la operación de actualización. Cada biblioteca cliente tiene una utilidad o un método auxiliar que generará la update_mask por ti, como se muestra en nuestras bibliotecas cliente.
remove
Quita el recurso.

Dado que el campo operation es un campo oneof, no puedes usar una sola operación para modificar varios objetos. Por ejemplo, si deseas crear una campaña y quitar otra, agrega dos instancias de CampaignOperation a tu solicitud: una con create configurado y otro con remove establecido.

Operaciones por lotes

Aunque una operación única solo puede crear, actualizar o quitar un recurso, una solicitud de mutación puede contener varias operaciones. Debes combinar tus operaciones en una sola solicitud de mutación en lugar de enviar varias solicitudes de modificación, y que cada una contenga una sola operación.

Por ejemplo, si deseas crear diez campañas, debes enviar una única MutateCampaignsRequest que tenga diez objetos CampaignOperation.

Modificar respuestas

Lo que se muestra en la respuesta depende de lo que se envió en el response_content_type de la solicitud de mutación. Por ejemplo, si se especificó MUTABLE_RESOURCE, la respuesta contendrá solo los campos mutables de la campaña. Luego, puedes realizar mutaciones de seguimiento en ese objeto de recursos sin tener que reconstruirlo.

Modificar errores

Las operaciones de una solicitud de mutación determinada solo se aplicarán a su cuenta de Google Ads si todas las operaciones de la solicitud se completan correctamente. Consulta la guía de errores comunes para ver una lista de errores comunes y cómo corregirlos.

Inspecciona objetos con get (obsoleto)

Además de cambiar los objetos, cada servicio específico del tipo de recurso también tiene un método get para recuperar todos los atributos de un recurso único. Este método acepta una solicitud get cuyo único atributo es resource_name.

Los métodos get son convenientes según la API de Google Ads para facilitar la recuperación de todos los atributos de un solo objeto. Si bien esta es una excelente herramienta para aprender a usar la API o inspeccionar un objeto individual con fines de depuración o educación, tu app no debería usar métodos get a fin de recuperar objetos a fin de procesarlos o generar informes. En su lugar, usa GoogleAdsService, ya que te permite recuperar solo atributos específicos de objetos, admite la recuperación de métricas de rendimiento y permite la transmisión a través de conjuntos de resultados grandes. Si tu app envía una gran cantidad de solicitudes de obtención, es posible que se alcancen los límites de frecuencia.