REST Resource: exchanges.orders.products

Recurso: Product

Produto

Representação JSON 
{
  "name": string,
  "displayName": string,
  "externalDealId": string,
  "transactionType": enum (TransactionType),
  "pricingType": enum (PricingType),
  "updateTime": string,
  "startTime": string,
  "endTime": string,
  "rateDetails": {
    object (RateDetails)
  },
  "creativeConfig": [
    {
      object (CreativeConfig)
    }
  ],
  "makegood": boolean,
  "makegoodDetails": {
    object (MakegoodDetails)
  },
  "creativeSource": enum (CreativeSource),
  "mediumType": enum (MediumType),
  "audienceTargetingConfig": {
    object (AudienceTargetingConfig)
  },
  "targetingCriteria": {
    object (TargetingCriteria)
  },
  "forecastResult": {
    object (ForecastResult)
  },
  "errorDetails": {
    object (ErrorDetails)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "etag": string
}
Campos
name

string

Nome da rota relativa do produto. Gerado pelo servidor. Exemplo: "exchanges/1234/orders/5678/products/abc". Apenas saída.
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.
externalDealId

string

ID externo. É 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.
transactionType

enum (TransactionType)

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

enum (PricingType)

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

string (Timestamp format)

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

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes 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".
startTime

string (Timestamp format)

O horário em que este produto será ativado. 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 padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes 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".
endTime

string (Timestamp format)

Data e hora em que o produto fica inativo. No momento, não pode ser posterior ao ano de 2036. Obrigatório.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes 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".
rateDetails

object (RateDetails)

Detalhes da tarifa. Obrigatório.
creativeConfig[]

object (CreativeConfig)

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

boolean

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

object (MakegoodDetails)

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

enum (CreativeSource)

Origem do criativo para um produto. Opcional. O padrão é CREATIVE_SOURCE_ADVERTISER. Não pode ser mudado depois da criação do produto.
mediumType

enum (MediumType)

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

object (AudienceTargetingConfig)

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

object (TargetingCriteria)

Apenas saída. Referências de critérios de segmentação por produto. Aplicável somente a cenários de ofertas instantâneas.
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 somente a cenários de ofertas instantâneas.
errorDetails

object (ErrorDetails)

Os detalhes do erro precisam ser especificados quando campos específicos do produto não podem ser atualizados. Obrigatório quando não é possível fornecer o resultado da previsão devido a um critério de segmentação ou quando não é possível atualizar o produto. Aplicável somente a cenários de ofertas instantâneas.
frequencyCap

object (FrequencyCap)

Apenas saída. Limite de frequência selecionado pelo comprador. Aplicável somente a cenários de ofertas instantâneas.
etag

string

Uma ETag que precisa ser especificada ao atualizar um produto. Ele só precisa ser especificado para uma atualização se o campo "etag" não estiver vazio. Aplicável somente a cenários de ofertas instantâneas.

CreativeConfig

Configuração de requisitos de criativo para um produto.

Representação JSON 
{
  "creativeType": enum (CreativeType),
  "dimensionCreativeConfig": {
    object (DimensionCreativeConfig)
  },
  "durationCreativeConfig": {
    object (DurationCreativeConfig)
  }
}
Campos
creativeType

enum (CreativeType)

Tipo de criativo. Obrigatório.
dimensionCreativeConfig

object (DimensionCreativeConfig)

A configuração dos criativos de display.

Esse campo não é compatível com criativos nativos (CREATIVE_TYPE_NATIVE).
durationCreativeConfig

object (DurationCreativeConfig)

A configuração dos criativos de vídeo.

CreativeType

Tipos de criativos possíveis.

Tipos enumerados
CREATIVE_TYPE_UNSPECIFIED Tipo de criativo não especificado. Valor de entrada inválido.
CREATIVE_TYPE_DISPLAY Tipo de criativo de display.
CREATIVE_TYPE_VIDEO Tipo de criativo de vídeo.
CREATIVE_TYPE_AUDIO Tipo de criativo de áudio.
CREATIVE_TYPE_NATIVE Tipo de criativo nativo.

DimensionCreativeConfig

Dimensão do criativo de display em pixels.

Representação JSON 
{
  "width": integer,
  "height": integer
}
Campos
width

integer

Largura do criativo de display. Obrigatório.
height

integer

Altura do criativo de display. Obrigatório.

DurationCreativeConfig

A configuração do criativo em duração.

Representação JSON 
{
  "duration": string,
  "durationMatchType": enum (DurationMatchType),
  "skippableMatchType": enum (SkippableMatchType)
}
Campos
duration

string (Duration format)

A duração do criativo de vídeo em segundos. Obrigatório

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".
durationMatchType

enum (DurationMatchType)

O critério de correspondência de duração.
skippableMatchType

enum (SkippableMatchType)

O tipo pulável de um criativo de vídeo.

DurationMatchType

Formatos possíveis para o critério de correspondência de duração.

Tipos enumerados
DURATION_MATCH_TYPE_UNSPECIFIED O critério de correspondência de duração não foi especificado ou é desconhecido nesta versão. Valor de entrada inválido.
DURATION_MATCH_TYPE_EQUAL_TO A duração do criativo precisa ser a mesma que a duração exigida.
DURATION_MATCH_TYPE_LESS_THAN_OR_EQUAL_TO A duração do criativo precisa ser igual ou menor que a duração necessária.

SkippableMatchType

Formatos possíveis para um produto.

Tipos enumerados
SKIPPABLE_MATCH_TYPE_UNSPECIFIED O tipo de conteúdo ignorável não foi especificado ou é desconhecido nesta versão. Valor de entrada inválido.
SKIPPABLE_MATCH_TYPE_SKIPPABLE O criativo precisa ser pulável.
SKIPPABLE_MATCH_TYPE_NOT_SKIPPABLE O criativo não pode ser pulável.
SKIPPABLE_MATCH_TYPE_ANY O criativo pode ser pulável ou não pulável.

MakegoodDetails

A configuração dos detalhes de compensação.

Representação JSON 
{
  "originalExternalDealId": string,
  "reason": string
}
Campos
originalExternalDealId

string

O ID externo original da transação que solicita uma compensação. Máximo de 100 caracteres. Os caracteres permitidos são alfanuméricos, sublinhado, traço e ponto. Obrigatório.
reason

string

Motivo da compensação iniciada pelo vendedor. Máximo de 250 caracteres. Obrigatório.

CreativeSource

Origem do criativo: de onde os criativos serão veiculados.

Tipos enumerados
CREATIVE_SOURCE_UNSPECIFIED A origem do criativo não foi especificada ou é desconhecida nesta versão. Valor de entrada inválido.
CREATIVE_SOURCE_ADVERTISER Os criativos serão veiculados pelo DV3.
CREATIVE_SOURCE_PUBLISHER Os criativos serão veiculados pelo publisher. No momento, os criativos hospedados pelo publisher não são compatíveis. Qualquer solicitação que tente definir a origem do criativo como CREATIVE_SOURCE_PUBLISHER vai falhar.

AudienceTargetingConfig

A configuração da segmentação por público-alvo.

Representação JSON 
{
  "audienceType": enum (AudienceType)
}
Campos
audienceType

enum (AudienceType)

O tipo de público-alvo. Obrigatório.

AudienceType

Tipo de público-alvo.

Tipos enumerados
AUDIENCE_TYPE_UNSPECIFIED Tipo de público-alvo não especificado. Não é válido para entrada.
AUDIENCE_TYPE_COMMERCE Tipo de público-alvo de comércio.

TargetingCriteria

Critérios de segmentação especificados.

Representação JSON 
{
  "selectedTargetingOptions": [
    {
      object (SelectedTargetingOption)
    }
  ]
}
Campos
selectedTargetingOptions[]

object (SelectedTargetingOption)

Opções selecionadas.

SelectedTargetingOption

A opção ou as opções de segmentação selecionadas para um único tipo de segmentação.

Representação JSON 
{
  "type": enum (TargetingType),

  // Union field value can be only one of the following:
  "audienceSelection": {
    object (AudienceSelection)
  },
  "targetingSelection": {
    object (TargetingSelection)
  }
  // End of list of possible types for union field value.
}
Campos
type

enum (TargetingType)

Tipo de segmentação associado às opções selecionadas.
Campo de união value. Só é possível incluir um tipo de seleção. A seleção escolhida precisa corresponder ao TargetingType escolhido para o campo "type". value pode ser apenas de um dos tipos a seguir:
audienceSelection

object (AudienceSelection)

Público-alvo selecionado.
targetingSelection

object (TargetingSelection)

Conjunto genérico de IDs de opções selecionadas.

TargetingType

Tipos de segmentação.

Tipos enumerados
TARGETING_TYPE_UNSPECIFIED Tipo de segmentação não especificado, não válido para entrada.
TARGETING_TYPE_AUDIENCE Público-alvo de tipo de segmentação.
TARGETING_TYPE_COUNTRY País do tipo de segmentação.
TARGETING_TYPE_DMA Tipo de segmentação "dma".
TARGETING_TYPE_PROGRAMMER Programador de tipo de segmentação.
TARGETING_TYPE_BRAND Marca do tipo de segmentação.
TARGETING_TYPE_CONTENT_GENRE Gênero de conteúdo do tipo de segmentação.
TARGETING_TYPE_DEVICE Dispositivo de tipo de segmentação.
TARGETING_TYPE_OPERATING_SYSTEM Sistema operacional de tipo de segmentação.
TARGETING_TYPE_RATING Classificação do tipo de segmentação.
TARGETING_TYPE_ENVIRONMENT Ambiente do tipo de segmentação.
TARGETING_TYPE_LANGUAGE Linguagem do tipo de segmentação.
TARGETING_TYPE_GEO Área geográfica do tipo de segmentação.
TARGETING_TYPE_AGE Segmentação por idade.
TARGETING_TYPE_GENDER Gênero do tipo de segmentação.
TARGETING_TYPE_CONTEXTUAL_SEGMENT Segmento contextual do tipo de segmentação.
TARGETING_TYPE_REQUEST_FORMAT Formato da solicitação de tipo de segmentação.
TARGETING_TYPE_PUBLISHER Publisher do tipo de segmentação.
TARGETING_TYPE_INVENTORY_SIZE Tamanho do tipo de segmentação.
TARGETING_TYPE_NETWORK Rede de tipo de segmentação.
TARGETING_TYPE_PLATFORM Plataforma do tipo de segmentação.
TARGETING_TYPE_VIDEO_DELIVERY_TYPE Tipo de segmentação do tipo de exibição de vídeo.
TARGETING_TYPE_VIDEO_MINIMUM_PLAYER_SIZE Segmentação por tamanho mínimo do player de vídeo.

AudienceSelection

Opções de segmentação por público-alvo selecionadas.

Representação JSON 
{
  "includedOrGroups": [
    {
      object (OrGroup)
    }
  ],
  "excludedOptionIds": [
    string
  ]
}
Campos
includedOrGroups[]

object (OrGroup)

As opções incluídas são combinadas com AND. Cada opção incluída pode ser individual ou um grupo de opções combinadas com OR.
excludedOptionIds[]

string (int64 format)

As opções excluídas são combinadas com "OR".

OrGroup

Um grupo de opções selecionadas unidas por OR.

Representação JSON 
{
  "optionIds": [
    string
  ]
}
Campos
optionIds[]

string (int64 format)

IDs das opções selecionadas.

TargetingSelection

Um conjunto de um ou mais IDs de opção selecionados, aplicável à maioria dos tipos de segmentação.

Representação JSON 
{
  "optionIds": [
    string
  ]
}
Campos
optionIds[]

string (int64 format)

IDs das opções selecionadas.

ForecastResult

Resultado da previsão especificado.

Representação JSON 
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
Campos
forecasts[]

object (Forecast)

Previsão. "forecastCategory" precisa ser exclusivo para cada elemento especificado.

Previsão

Previsão da categoria especificada.

Representação JSON 
{
  "forecastCategory": enum (ForecastCategory),

  // Union field forecast_data can be only one of the following:
  "number": string,
  "percentage": integer,
  "cpmPrice": {
    object (Money)
  },
  "cpmRange": {
    object (CpmRange)
  },
  "forecastBreakdownData": {
    object (ForecastBreakdownData)
  }
  // End of list of possible types for union field forecast_data.
}
Campos
forecastCategory

enum (ForecastCategory)

A categoria de previsão especificada que a estatística de previsão representava.
Campo de união forecast_data. Só é possível incluir um tipo de dados de estatísticas. Os dados preenchidos precisam corresponder ao campo "forecastCategory". forecast_data pode ser apenas de um dos tipos a seguir:
number

string (int64 format)

Dados numéricos.
percentage

integer

Dados de porcentagem.
cpmPrice

object (Money)

Dados de preços de CPM.
cpmRange

object (CpmRange)

Dados de faixa de preço de CPM.
forecastBreakdownData

object (ForecastBreakdownData)

Dados de detalhamento da estimativa.

ForecastCategory

Categoria de previsão.

Tipos enumerados
FORECAST_CATEGORY_UNSPECIFIED Categoria não especificada. Não é válido para entrada.
FORECAST_CATEGORY_TOTAL_OPPORTUNITIES Total de oportunidades. Dados numéricos.
FORECAST_CATEGORY_TOTAL_AUDIENCE Público-alvo total. Dados numéricos.
FORECAST_CATEGORY_DIGITAL_TRP Pontos de audiência no público-alvo digital. Dados de porcentagem.
FORECAST_CATEGORY_SUGGESTED_CPM Preço de CPM sugerido. Faixa de CPM ou dados de preço de CPM.
FORECAST_CATEGORY_UNIQUE_REACH Prever o alcance único. Dados numéricos.
FORECAST_CATEGORY_FORECAST_BREAKDOWN Detalhamento da estimativa. Dados de detalhamento da estimativa.

CpmRange

O intervalo de CPM contém o mínimo e o máximo do CPM.

Representação JSON 
{
  "minCpm": {
    object (Money)
  },
  "maxCpm": {
    object (Money)
  }
}
Campos
minCpm

object (Money)

Limite inferior da faixa de CPM.
maxCpm

object (Money)

Limite superior da faixa de CPM.

ForecastBreakdownData

Os dados de detalhamento da previsão contêm uma lista de detalhamentos.

Representação JSON 
{
  "forecastBreakdowns": [
    {
      object (ForecastBreakdown)
    }
  ]
}
Campos
forecastBreakdowns[]

object (ForecastBreakdown)

Uma lista de detalhamentos de previsão.

ForecastBreakdown

Detalhamento da estimativa da opção de segmentação selecionada.

Representação JSON 
{
  "selectedTargetingOption": {
    object (SelectedTargetingOption)
  },

  // Union field breakdown_data can be only one of the following:
  "impressions": string
  // End of list of possible types for union field breakdown_data.
}
Campos
selectedTargetingOption

object (SelectedTargetingOption)

A opção ou as opções de segmentação selecionadas para um único tipo de segmentação.
Campo de união breakdown_data. Só um tipo de dados de detalhamento pode ser incluído. breakdown_data pode ser apenas de um dos tipos a seguir:
impressions

string (int64 format)

Prever impressões.

ErrorDetails

Detalhes do erro especificados quando a atualização tem erros.

Representação JSON 
{
  "message": string,
  "instantDealErrorStatus": enum (InstantDealErrorStatus)
}
Campos
message

string

A mensagem especificada quando a atualização tem erros.
instantDealErrorStatus

enum (InstantDealErrorStatus)

O status de erro especificado quando a atualização tem erros para as ofertas instantâneas.

InstantDealErrorStatus

Status de erro especificado quando a atualização da oferta instantânea tem erros.

Tipos enumerados
INSTANT_DEAL_ERROR_STATUS_UNSPECIFIED Status de erro não especificado.
INSTANT_DEAL_ERROR_STATUS_INVENTORY_UNAVAILABLE O status de erro indica que o inventário está indisponível.
INSTANT_DEAL_ERROR_STATUS_FORECAST_UNAVAILABLE O status de erro indica que a previsão não está disponível.
INSTANT_DEAL_ERROR_STATUS_INVALID_INPUT O status de erro indica que há campos de entrada inválidos.

FrequencyCap

O número de vezes que um usuário pode ver o mesmo anúncio durante um determinado período.

Representação JSON 
{
  "timeUnit": enum (TimeUnit),
  "maxImpressions": string
}
Campos
timeUnit

enum (TimeUnit)

A unidade de tempo em que o limite de frequência será aplicado.
maxImpressions

string (int64 format)

O número máximo de vezes que um usuário pode ver o mesmo anúncio durante esse período.

TimeUnit

A unidade de tempo em que o limite de frequência será aplicado.

Tipos enumerados
TIME_UNIT_UNSPECIFIED Unidade de tempo não especificada.
TIME_UNIT_LIFETIME O limite de frequência será aplicado a toda a vida útil.
TIME_UNIT_MONTHS O limite de frequência será aplicado a vários meses.
TIME_UNIT_WEEKS O limite de frequência será aplicado por várias semanas.
TIME_UNIT_DAYS O limite de frequência será aplicado a um número de dias.

Métodos

create

 Cria um produto.

get

 Recebe o produto.

list

 Lista o produto.

patch

 Atualiza um produto.