GoogleApi.DFAReporting.V34.Api.OrderDocuments (google_api_dfa_reporting v0.31.0)

API calls for all endpoints tagged OrderDocuments.

Summary

Functions

dfareporting_order_documents_get(connection, profile_id, project_id, id, optional_params \\ [], opts \\ [])

Gets one order document by ID.

dfareporting_order_documents_list(connection, profile_id, project_id, optional_params \\ [], opts \\ [])

Retrieves a list of order documents, possibly filtered. This method supports paging.

Functions

dfareporting_order_documents_get(connection, profile_id, project_id, id, optional_params \\ [], opts \\ [])

@spec dfareporting_order_documents_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.OrderDocument.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets one order document by ID.

Parameters

connection (type: GoogleApi.DFAReporting.V34.Connection.t) - Connection to server
profile_id (type: String.t) - User profile ID associated with this request.
project_id (type: String.t) - Project ID for order documents.
id (type: String.t) - Order document ID.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.DFAReporting.V34.Model.OrderDocument{}} on success
{:error, info} on failure

dfareporting_order_documents_list(connection, profile_id, project_id, optional_params \\ [], opts \\ [])

@spec dfareporting_order_documents_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V34.Model.OrderDocumentsListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a list of order documents, possibly filtered. This method supports paging.

Parameters

connection (type: GoogleApi.DFAReporting.V34.Connection.t) - Connection to server
profile_id (type: String.t) - User profile ID associated with this request.
project_id (type: String.t) - Project ID for order documents.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :approved (type: boolean()) - Select only order documents that have been approved by at least one user.
- :ids (type: list(String.t)) - Select only order documents with these IDs.
- :maxResults (type: integer()) - Maximum number of results to return.
- :orderId (type: list(String.t)) - Select only order documents for specified orders.
- :pageToken (type: String.t) - Value of the nextPageToken from the previous result page.
- :searchString (type: String.t) - Allows searching for order documents by name or ID. Wildcards () are allowed. For example, "orderdocument2015" will return order documents with names like "orderdocument June 2015", "orderdocument April 2015", or simply "orderdocument 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "orderdocument" will match order documents with name "my orderdocument", "orderdocument 2015", or simply "orderdocument".
- :siteId (type: list(String.t)) - Select only order documents that are associated with these sites.
- :sortField (type: String.t) - Field by which to sort the list.
- :sortOrder (type: String.t) - Order of sorted results.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.DFAReporting.V34.Model.OrderDocumentsListResponse{}} on success
{:error, info} on failure