Transformar e recuperar recursos

Cada recurso da API Waze Ads Management tem um serviço correspondente que permite realizar operações nos recursos. Todos os serviços têm estes métodos:

  • Aplicar o comando create, que cria uma instância do recurso
  • Aplicar o comando update, que atualiza uma instância do recurso
  • Aplicar o comando get, que envia uma instância do recurso para inspeção
  • Aplicar o comando list, que mostra todas as instâncias do recurso que o usuário autenticado pode acessar

Este guia usa o serviço CampaignService para demonstrar como manipular e inspecionar recursos de Campaign, mas os mesmos conceitos também se aplicam a todos os outros serviços.

Criar recursos

Cada serviço tem um método create que aceita uma solicitação, que consiste no seguinte:

  • No URL, um ACCOUNT_ID da conta em que esse recurso será criado
  • Uma instância do recurso com todos os campos obrigatórios.

Por exemplo, o URL do método accounts.campaigns.create v1/accounts/ACCOUNT_ID/campaigns aceita uma Campaign.

Atualizar recursos

Cada serviço tem um método patch que aceita uma solicitação, que consiste no seguinte:

  • Um name do recurso no URL
  • Uma updateMask, que é uma máscara de campo responsável por informar a API Waze Ads sobre quais campos do recurso deverão ser modificados
  • Um recurso parcial com os campos que você quer corrigir

Recuperar recursos

Além da capacidade de criar e atualizar objetos, cada serviço tem um método get para recuperar todos os atributos de um único recurso. Esse método aceita uma solicitação GET que tenha name como único atributo.

Listar recursos

Para recuperar todos os atributos das instâncias de um recurso, cada serviço tem um método list que aceita uma solicitação GET com estes itens:

  • Um ACCOUNT_ID no URL
  • Um pageSize para indicar o número máximo de recursos que serão retornados
  • Um pageToken, recebido de uma chamada list anterior, para recuperar uma página subsequente

Se o pageSize não for especificado, até 50 recursos serão retornados. O valor máximo é 1.000. Valores maiores serão revertidos para 1.000. Ao fazer a paginação, o pageSize precisa corresponder à chamada que forneceu o pageToken.