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 route 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
    },
    "etag": string
  },
  "updateMask": string
}
Champs
product.displayName

string

Nom à afficher du produit.

Doit être encodé en UTF-8 et ne pas dépasser 240 octets. Obligatoire.

product.externalDealId

string

ID externe. Il s'agit de l'ID de l'accord dans 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. Doit être unique pour tous les produits. Obligatoire.

product.transactionType

enum (TransactionType)

Type de transaction pour le 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 est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" 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 postérieure de plus d'un an à la date du jour. Obligatoire.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" 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)

Date à laquelle ce produit devient inactif. Actuellement, la date ne peut pas être ultérieure à l'année 2036. Obligatoire.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" 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 de transaction réservé.

product.makegood
(deprecated)

boolean

Indique si un produit est un produit de remplacement.

product.makegoodDetails
(deprecated)

object (MakegoodDetails)

Informations sur la compensation pour un produit. Obligatoire lorsque le produit est un geste commercial.

product.creativeSource

enum (CreativeSource)

Source de la création pour un produit. Facultatif. La valeur par défaut est CREATIVE_SOURCE_ADVERTISER. Ce paramètre ne peut pas être modifié après la création du produit.

product.mediumType

enum (MediumType)

Type de taille pour un produit. En l'absence de spécification, la valeur par défaut est DIGITAL pour assurer la rétrocompatibilité. Ce paramètre ne peut pas être modifié après la création du produit.

product.audienceTargetingConfig

object (AudienceTargetingConfig)

Facultatif. La configuration de ciblage par audience sélectionnée s'applique au niveau de l'accord sur Exchange.

product.targetingCriteria

object (TargetingCriteria)

Uniquement en sortie. Références des critères de ciblage de produits Ne s'applique qu'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. Ne s'applique qu'aux scénarios d'accords instantanés.

product.errorDetails

object (ErrorDetails)

Vous devez spécifier les détails de l'erreur lorsque des champs de produit spécifiques 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'il est impossible de mettre à jour le produit. Ne s'applique qu'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. Ne s'applique qu'aux scénarios d'accords instantanés.

product.etag

string

Étiquette à 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. Ne s'applique qu'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 en savoir plus, consultez OAuth 2.0 Overview.