Method: exchanges.orders.patch

Met à jour une commande.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
order.name

string

Nom de ressource relatif de la commande. Généré par le serveur. Exemple : "exchanges/1234/orders/5678". 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
{
  "order": {
    "name": string,
    "displayName": string,
    "partnerId": [
      string
    ],
    "publisherEmail": string,
    "publisherName": string,
    "budget": {
      "budgetType": enum (BudgetType),

      // The following is a list of mutually exclusive fields. At most one of the
      // fields will be set in a response:
      "impressions": string,
      "money": {
        object (Money)
      }
      // End of mutually exclusive fields.
    },
    "status": enum (OrderStatus),
    "wseatConfig": {
      "exchangeWseatStatus": enum (WSeatStatus),
      "exchangeWseatIds": [
        string
      ],
      "updateTime": string
    },
    "updateTime": string,
    "buyerInfo": {
      "partner": {
        object (PartnerInfo)
      },
      "advertisers": [
        {
          object (AdvertiserInfo)
        }
      ]
    }
  },
  "updateMask": string
}
Champs
order.displayName

string

Nom de la commande affiché à l'acheteur. 250 caractères maximum. Facultatif.

order.partnerId[]

string (int64 format)

ID de partenaire dans Google Display &Video 360, anciennement DoubleClick Bid Manager(DBM). N'autorise qu'un seul ID de partenaire. Obligatoire.

order.publisherEmail

string

Adresse e-mail de l'éditeur. Doit être au format d'adresse e-mail valide. 250 caractères maximum. Facultatif.

order.publisherName

string

Nom de l'éditeur. 250 caractères maximum. Obligatoire.

order.budget

object (Budget)

Uniquement en sortie. Budget défini par l'acheteur. Applicable uniquement aux scénarios d'accord instantané.

order.status

enum (OrderStatus)

État de la commande. L'état peut changer après que les utilisateurs de DV3 ont accepté, annulé ou archivé une commande. Permet également de mettre à jour l'état sur "ANNULÉ" après la création dans l'API pour indiquer que cette commande a été annulée sur l'Ad Exchange.

order.wseatConfig

object (WSeatConfig)

Facultatif. La configuration WSeat spécifie la configuration WSeat côté Ad Exchange. Les Ad Exchanges qui utilisent des accords multi-sièges doivent maintenir ce champ renseigné et à jour.

order.updateTime

string (Timestamp format)

Uniquement en sortie. Timestamp indiquant la date et l'heure de mise à jour de la commande ou des produits sous-jacents.

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".

order.buyerInfo

object (BuyerInfo)

Uniquement en sortie. Informations sur l'acheteur, y compris les détails du partenaire et de l'annonceur. Applicable uniquement aux scénarios d'accord instantané.

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 Order.

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.