Method: orderDocuments.get

  • This API call retrieves a single order document using its ID.

  • The request uses a GET method with a URL that includes the user profile ID, project ID, and the specific order document ID.

  • Path parameters profileId, projectId, and id are required and are strings with an int64 format.

  • The request body should be empty.

  • A successful response will return an instance of the OrderDocument object and requires the https://www.googleapis.com/auth/dfatrafficking authorization scope.

Gets one order document by ID.

HTTP request

GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/projects/{projectId}/orderDocuments/{id}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

User profile ID associated with this request.
projectId

string (int64 format)

Project ID for order documents.
id

string (int64 format)

Order document ID.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of OrderDocument.

Authorization Scopes

Requires the following OAuth scope:

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