Method: exchanges.orders.products.patch

Met à jour un produit.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
product.name

string

Nom de ressource relatif du produit. Généré par le serveur. Exemple : "exchanges/1234/orders/5678/products/abc". Uniquement en sortie.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation 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
    },
    "program": string,
    "buyerCustomParameters": {
      string: string,
      ...
    },
    "etag": string
  },
  "updateMask": string
}
Champs
product.displayName

string

Nom à afficher du produit.

Doit être encodé en UTF-8 avec une taille maximale de 240 octets. Obligatoire.
product.externalDealId

string

ID externe. Il s'agit de l'ID de l'accord sur le système de la place de marché. 100 caractères max. Les caractères autorisés sont les caractères alphanumériques, les traits de soulignement, les tirets et les points. Il doit être unique pour tous les produits. Obligatoire.
product.transactionType

enum (TransactionType)

Type de transaction du produit. Obligatoire.
product.pricingType

enum (PricingType)

Type de tarification du produit. Obligatoire.
product.updateTime
(deprecated)

string (Timestamp format)

Code temporel de la dernière mise à jour du produit.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
product.startTime

string (Timestamp format)

Heure à laquelle ce produit devient actif. Doit être antérieure à endTime. L'heure de début ne peut pas être située dans plus d'un an. Obligatoire.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
product.endTime

string (Timestamp format)

Heure à laquelle ce produit devient inactif. Ne peut pas être postérieure à l'année 2036. Obligatoire.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
product.rateDetails

object (RateDetails)

Détails du tarif. Obligatoire.
product.creativeConfig[]

object (CreativeConfig)

Exigences concernant les créations pour un produit. Obligatoire pour les produits de type transaction réservée.
product.makegood
(deprecated)

boolean

Indique si un produit est un produit de compensation.
product.makegoodDetails
(deprecated)

object (MakegoodDetails)

Détails de la compensation pour un produit. Obligatoire lorsque le produit est une compensation.
product.creativeSource

enum (CreativeSource)

Source de création d'un produit. Facultatif, la valeur par défaut est CREATIVE_SOURCE_ADVERTISER. Non modifiable après la création du produit.
product.mediumType

enum (MediumType)

Type de support d'un produit. En l'absence de spécification, la valeur par défaut est DIGITAL pour assurer la rétrocompatibilité. Non modifiable après la création du produit.
product.audienceTargetingConfig

object (AudienceTargetingConfig)

Facultatif. La configuration du ciblage d'audience est appliquée au niveau de l'accord sur la place de marché.
product.targetingCriteria

object (TargetingCriteria)

Uniquement en sortie. Références des critères de ciblage de produits. Applicable uniquement aux scénarios d'accords instantanés.
product.forecastResult

object (ForecastResult)

Résultats des prévisions de produits. Obligatoire lorsque les critères de ciblage ne sont pas vides et que la prévision n'est pas fournie. Applicable uniquement aux scénarios d'accords instantanés.
product.errorDetails

object (ErrorDetails)

Vous devez spécifier les détails de l'erreur lorsque certains champs de produit ne peuvent pas être mis à jour. Obligatoire lorsque le résultat de la prévision ne peut pas être fourni en raison d'un critère de ciblage ou qu'une mise à jour ne peut pas être effectuée sur le produit. Applicable uniquement aux scénarios d'accords instantanés.
product.frequencyCap

object (FrequencyCap)

Uniquement en sortie. Limite de la fréquence d'exposition sélectionnée par l'acheteur. Applicable uniquement aux scénarios d'accords instantanés.
product.program

string

Uniquement en sortie. Programme dans le cadre duquel l'acheteur a créé l'accord instantané. Laissez ce champ vide pour le flux d'échange standard. Applicable uniquement aux scénarios d'accords instantanés.
product.buyerCustomParameters

map (key: string, value: string)

Uniquement en sortie. Paramètres de clé/valeur personnalisés définis par l'acheteur dans la demande d'accord instantané. Applicable uniquement aux scénarios d'accords instantanés.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
product.etag

string

Etag à spécifier lors de la mise à jour d'un produit. Il ne doit être spécifié pour une mise à jour que si le champ etag n'est pas vide. Applicable uniquement aux scénarios d'accords instantanés.
updateMask

string (FieldMask format)

Masque permettant de contrôler les champs à mettre à jour. Obligatoire.

Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo".

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Product.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour plus d'informations, consultez la OAuth 2.0 Overview.