google_api_dfa_reporting v0.15.0 GoogleApi.DFAReporting.V33.Api.Orders View Source

API calls for all endpoints tagged Orders.

Link to this section Summary

Link to this section Functions

Link to this function

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

View Source

Specs

dfareporting_orders_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V33.Model.Order.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets one order by ID.

Parameters

  • connection (type: GoogleApi.DFAReporting.V33.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 orders.
  • id (type: String.t) - Order ID.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DFAReporting.V33.Model.Order{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

dfareporting_orders_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DFAReporting.V33.Model.OrdersListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.DFAReporting.V33.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 orders.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :ids (type: list(String.t)) - Select only orders with these IDs.
    • :maxResults (type: integer()) - Maximum number of results to return.
    • :pageToken (type: String.t) - Value of the nextPageToken from the previous result page.
    • :searchString (type: String.t) - Allows searching for orders by name or ID. Wildcards () are allowed. For example, "order2015" will return orders with names like "order June 2015", "order April 2015", or simply "order 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 "order" will match orders with name "my order", "order 2015", or simply "order".
    • :siteId (type: list(String.t)) - Select only orders that are associated with these site IDs.
    • :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.V33.Model.OrdersListResponse{}} on success
  • {:error, info} on failure