Method: customers.customAudiences.mutate

Создает или обновляет пользовательские аудитории. Статусы операций возвращаются.

Список выброшенных ошибок: AuthenticationError AuthorizationError CustomAudienceError CustomInterestError FieldError FieldMaskError HeaderError InternalError MutateError OperationAccessDeniedError PolicyViolationError QuotaError RequestError

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
customerId

string

Необходимый. Идентификатор клиента, чьи пользовательские аудитории изменяются.

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление
{
  "operations": [
    {
      object (CustomAudienceOperation)
    }
  ],
  "validateOnly": boolean
}
Поля
operations[]

object ( CustomAudienceOperation )

Необходимый. Список операций, которые необходимо выполнить с отдельными пользовательскими аудиториями.

validateOnly

boolean

Если это правда, запрос проверяется, но не выполняется. Возвращаются только ошибки, а не результаты.

Тело ответа

Ответное сообщение для изменения пользовательской аудитории.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление
{
  "results": [
    {
      object (MutateCustomAudienceResult)
    }
  ]
}
Поля
results[]

object ( MutateCustomAudienceResult )

Все результаты для mutate.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

CustomAudienceOperation

Одна операция (создание, обновление) для индивидуальной аудитории.

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.
}
Поля
updateMask

string ( FieldMask format)

FieldMask, определяющая, какие поля ресурсов изменяются при обновлении.

Это разделенный запятыми список полных имен полей. Пример: "user.displayName,photo" .

Полевая operation Союза. Операция мутации. operation может быть только одной из следующих:
create

object ( CustomAudience )

Операция создания: для новой пользовательской аудитории не ожидается имя ресурса.

update

object ( CustomAudience )

Операция обновления: ожидается, что пользовательская аудитория будет иметь допустимое имя ресурса.

remove

string

Операция удаления: ожидается имя ресурса для удаленной пользовательской аудитории в следующем формате:

customers/{customerId}/customAudiences/{custom_audience_id}

MutateCustomAudienceResult

Результат изменения пользовательской аудитории.

JSON-представление
{
  "resourceName": string
}
Поля
resourceName

string

Вернулся для успешных операций.