google_api_content v0.52.0

GoogleApi.Content.V2.Api.Orderreports (google_api_content v0.52.0) View Source

API calls for all endpoints tagged Orderreports.

Link to this section Summary

Functions

content_orderreports_listdisbursements(connection, merchant_id, optional_params \\ [], opts \\ [])

Retrieves a report for disbursements from your Merchant Center account.

content_orderreports_listtransactions(connection, merchant_id, disbursement_id, optional_params \\ [], opts \\ [])

Retrieves a list of transactions for a disbursement from your Merchant Center account.

Link to this section Functions

Link to this function

content_orderreports_listdisbursements(connection, merchant_id, optional_params \\ [], opts \\ [])

View Source

Specs

content_orderreports_listdisbursements(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V2.Model.OrderreportsListDisbursementsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Retrieves a report for disbursements from your Merchant Center account.

Parameters

  • connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
  • merchant_id (type: String.t) - The ID of the account that manages the order. This cannot be a multi-client account.
  • 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").
    • :disbursementEndDate (type: String.t) - The last date which disbursements occurred. In ISO 8601 format. Default: current date.
    • :disbursementStartDate (type: String.t) - The first date which disbursements occurred. In ISO 8601 format.
    • :maxResults (type: integer()) - The maximum number of disbursements to return in the response, used for paging.
    • :pageToken (type: String.t) - The token returned by the previous request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Content.V2.Model.OrderreportsListDisbursementsResponse{}} on success
  • {:error, info} on failure
Link to this function

content_orderreports_listtransactions(connection, merchant_id, disbursement_id, optional_params \\ [], opts \\ [])

View Source

Specs

content_orderreports_listtransactions(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V2.Model.OrderreportsListTransactionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Retrieves a list of transactions for a disbursement from your Merchant Center account.

Parameters

  • connection (type: GoogleApi.Content.V2.Connection.t) - Connection to server
  • merchant_id (type: String.t) - The ID of the account that manages the order. This cannot be a multi-client account.
  • disbursement_id (type: String.t) - The Google-provided ID of the disbursement (found in Wallet).
  • 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").
    • :maxResults (type: integer()) - The maximum number of disbursements to return in the response, used for paging.
    • :pageToken (type: String.t) - The token returned by the previous request.
    • :transactionEndDate (type: String.t) - The last date in which transaction occurred. In ISO 8601 format. Default: current date.
    • :transactionStartDate (type: String.t) - The first date in which transaction occurred. In ISO 8601 format.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Content.V2.Model.OrderreportsListTransactionsResponse{}} on success
  • {:error, info} on failure