A API Campaign Manager 360 v3.4 foi descontinuada e será desativada em 10 de janeiro de 2022. Até essa data, todos os usuários precisam migrar para uma versão mais recente da API.

OrderDocuments

Para ver uma lista de métodos desse recurso, consulte o final desta página.

Representações do recurso

Contém propriedades de um documento de pedido de planejamento..

{
  "kind": "dfareporting#orderDocument",
  "id": long,
  "orderId": long,
  "accountId": long,
  "subaccountId": long,
  "advertiserId": long,
  "projectId": long,
  "title": string,
  "type": string,
  "amendedOrderDocumentId": long,
  "effectiveDate": date,
  "signed": boolean,
  "cancelled": boolean,
  "approvedByUserProfileIds": [
    long
  ],
  "createdInfo": {
    "time": long
  },
  "lastSentTime": datetime,
  "lastSentRecipients": [
    string
  ]
}
Nome da propriedade Valor Descrição Observações
accountId long É o ID da conta deste documento de pedido.
advertiserId long É o ID do anunciante deste documento de pedido.
amendedOrderDocumentId long É o ID alterado deste documento de pedido. Também é possível mudar outro documento de pedido para criar um novo. Assim o histórico de alterações é preservado.
approvedByUserProfileIds[] list São os IDs dos usuários que aprovaram este documento de pedido.
cancelled boolean Indica se este documento de pedido foi cancelado.
createdInfo nested object São informações sobre a criação deste documento de pedido.
createdInfo.time long É o carimbo de data/hora da última mudança em milissegundos desde a época.
effectiveDate date É o início da vigência deste documento de pedido.
id long É o ID deste documento de pedido.
kind string Identifica o tipo de recurso. Valor: a string fixa "dfareporting#orderDocument".
lastSentRecipients[] list É a lista de endereços de e-mail que receberam o último documento enviado.
lastSentTime datetime É o carimbo de data/hora do último e-mail enviado com este documento de pedido.
orderId long É o ID do pedido de que este documento foi criado.
projectId long É o ID do projeto deste documento de pedido.
signed boolean Indica se este documento de pedido foi assinado.
subaccountId long É o ID da subconta deste documento de pedido.
title string É o título deste documento de pedido.
type string É o tipo deste documento de pedido.

Os valores aceitáveis são os seguintes:
  • "PLANNING_ORDER_TYPE_CHANGE_ORDER"
  • "PLANNING_ORDER_TYPE_INSERTION_ORDER"

Métodos

get
Recebe um documento de pedido por ID.
list
Recupera uma lista de documentos de pedido, possivelmente filtrada. Esse método é compatível com paginação.