Method: exchanges.orders.products.patch

Atualiza um produto.

Solicitação HTTP

PATCH https://dv360seller.googleapis.com/v1beta1/{product.name=exchanges/*/orders/*/products/*}

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

Parâmetros de caminho

Parâmetros
product.name

string

Nome da rota relativa para o produto. Gerado pelo servidor. Exemplo: "exchanges/1234/orders/5678/products/abc". Apenas saída.

Corpo da solicitação

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

Representação JSON 
{
  "product": {
    "name": string,
    "displayName": string,
    "externalDealId": string,
    "transactionType": enum (TransactionType),
    "pricingType": enum (PricingType),
    "updateTime": string,
    "startTime": string,
    "endTime": string,
    "rateDetails": {
      "rateType": enum (RateType),
      "rate": {
        object (Money)
      },
      "unitsPurchasedCount": string
    },
    "creativeConfig": [
      {
        "creativeType": enum (CreativeType),
        "dimensionCreativeConfig": {
          object (DimensionCreativeConfig)
        },
        "durationCreativeConfig": {
          object (DurationCreativeConfig)
        }
      }
    ],
    "makegood": boolean,
    "makegoodDetails": {
      "originalExternalDealId": string,
      "reason": string
    },
    "creativeSource": enum (CreativeSource),
    "mediumType": enum (MediumType),
    "audienceTargetingConfig": {
      "audienceType": enum (AudienceType)
    },
    "targetingCriteria": {
      "selectedTargetingOptions": [
        {
          object (SelectedTargetingOption)
        }
      ]
    },
    "forecastResult": {
      "forecasts": [
        {
          object (Forecast)
        }
      ]
    },
    "errorDetails": {
      "message": string,
      "instantDealErrorStatus": enum (InstantDealErrorStatus)
    },
    "frequencyCap": {
      "timeUnit": enum (TimeUnit),
      "maxImpressions": string
    },
    "etag": string
  },
  "updateMask": string
}
Campos
product.displayName

string

O nome de exibição do produto.

Precisa ser codificado em UTF-8 com um tamanho máximo de 240 bytes. Obrigatório.
product.externalDealId

string

ID externo. Esse é o ID da transação no sistema de troca. Máximo de 100 caracteres. Os caracteres permitidos são alfanuméricos, sublinhado, traço e ponto. Precisa ser exclusivo em todos os produtos. Obrigatório.
product.transactionType

enum (TransactionType)

Tipo de transação do produto. Obrigatório.
product.pricingType

enum (PricingType)

Tipo de preço do produto. Obrigatório.
product.updateTime
(deprecated)

string (Timestamp format)

O carimbo de data/hora da última atualização do produto.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
product.startTime

string (Timestamp format)

O momento em que o produto fica ativo. Precisa ser anterior a endTime. O horário de início não pode ser mais de um ano no futuro. Obrigatório.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
product.endTime

string (Timestamp format)

O momento em que o produto fica inativo. No momento, não pode ser posterior a 2036. Obrigatório.

Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
product.rateDetails

object (RateDetails)

Detalhes da tarifa. Obrigatório.
product.creativeConfig[]

object (CreativeConfig)

Os requisitos de criativo para um produto. Obrigatório para produtos do tipo transação reservada.
product.makegood
(deprecated)

boolean

Indica se um produto é de compensação.
product.makegoodDetails
(deprecated)

object (MakegoodDetails)

Os detalhes do substituto de um produto. Obrigatório quando o produto é uma compensação.
product.creativeSource

enum (CreativeSource)

Origem do criativo de um produto. Opcional: o padrão é CREATIVE_SOURCE_ADVERTISER. Não é possível mudar depois da criação do produto.
product.mediumType

enum (MediumType)

Tipo de mídia de um produto. O padrão é DIGITAL se não for especificado para compatibilidade com versões anteriores. Não é possível mudar depois da criação do produto.
product.audienceTargetingConfig

object (AudienceTargetingConfig)

Opcional. A configuração de segmentação por público-alvo selecionada foi aplicada no nível da transação na troca.
product.targetingCriteria

object (TargetingCriteria)

Apenas saída. Referências aos critérios de segmentação por produto. Aplicável apenas a cenários de transação instantânea.
product.forecastResult

object (ForecastResult)

Resultados da previsão de produtos. Obrigatório quando os critérios de segmentação não estão vazios e a previsão não é fornecida. Aplicável apenas a cenários de transação instantânea.
product.errorDetails

object (ErrorDetails)

Os detalhes do erro precisam ser especificados quando campos específicos do produto não podem ser atualizados. Obrigatório quando o resultado da previsão não pode ser fornecido devido a um critério de segmentação ou não é possível fazer uma atualização no produto. Aplicável apenas a cenários de transação instantânea.
product.frequencyCap

object (FrequencyCap)

Apenas saída. Limite de frequência selecionado pelo comprador. Aplicável apenas a cenários de transação instantânea.
product.etag

string

Um ETag que precisa ser especificado ao atualizar um produto. Ele só precisa ser especificado para uma atualização se o campo etag não estiver vazio. Aplicável apenas a cenários de transação instantânea.
updateMask

string (FieldMask format)

A máscara para controlar quais campos serão atualizados. Obrigatório.

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

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Product.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.