Method: customers.customAudiences.mutate

Cria ou atualiza públicos-alvo personalizados. Os status da operação são retornados.

Lista de erros gerados: AuthenticationError AuthorizationError CustomAudienceError CustomInterestError FieldError FieldMaskError HeaderError InternalError MutateError OperationAccessDeniedError PolicyViolationError QuotaErrorRequestError

Solicitação HTTP

POST https://googleads.googleapis.com/v14/customers/{customerId}/customAudiences:mutate

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
customerId

string

Obrigatório. ID do cliente cujos públicos-alvo personalizados estão sendo modificados.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON
{
  "operations": [
    {
      object (CustomAudienceOperation)
    }
  ],
  "validateOnly": boolean
}
Campos
operations[]

object (CustomAudienceOperation)

Obrigatório. A lista de operações a serem realizadas em públicos-alvo personalizados individuais.

validateOnly

boolean

Se verdadeiro, a solicitação é validada, mas não executada. Somente erros são retornados, não resultados.

Corpo da resposta

Mensagem de resposta para a mudança do público-alvo personalizado.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "results": [
    {
      object (MutateCustomAudienceResult)
    }
  ]
}
Campos
results[]

object (MutateCustomAudienceResult)

Todos os resultados para a função mutate.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/adwords

Para mais informações, consulte a Visão geral do OAuth 2.0.

CustomAudienceOperation

Uma operação única de criação ou atualização em um público-alvo personalizado.

Representação JSON
{
  "updateMask": string,

  // Union field operation can be only one of the following:
  "create": {
    object (CustomAudience)
  },
  "update": {
    object (CustomAudience)
  },
  "remove": string
  // End of list of possible types for union field operation.
}
Campos
updateMask

string (FieldMask format)

FieldMask que determina quais campos de recursos são modificados em uma atualização.

Esta é uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".

Campo de união operation. A operação de mutação. operation pode ser apenas de um dos tipos a seguir:
create

object (CustomAudience)

Operação de criação: nenhum nome de recurso é esperado para o novo público-alvo personalizado.

update

object (CustomAudience)

Operação de atualização: o público-alvo personalizado precisa ter um nome de recurso válido.

remove

string

Operação de remoção: é esperado um nome de recurso para o público-alvo personalizado removido, neste formato:

customers/{customerId}/customAudiences/{custom_audience_id}

MutateCustomAudienceResult

Resultado da mudança do público-alvo personalizado.

Representação JSON
{
  "resourceName": string
}
Campos
resourceName

string

É retornado para operações bem-sucedidas.