View Source GoogleApi.MerchantAPI.Reports_v1beta.Api.Accounts (google_api_merchant_api v0.3.0)

API calls for all endpoints tagged Accounts.

Summary

Functions

Retrieves a report defined by a search query. The response might contain fewer rows than specified by page_size. Rely on next_page_token to determine if there are more rows to be requested.

Functions

Link to this function

merchantapi_accounts_reports_search(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec merchantapi_accounts_reports_search(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.MerchantAPI.Reports_v1beta.Model.SearchResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a report defined by a search query. The response might contain fewer rows than specified by page_size. Rely on next_page_token to determine if there are more rows to be requested.

Parameters

  • connection (type: GoogleApi.MerchantAPI.Reports_v1beta.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Id of the account making the call. Must be a standalone account or an MCA subaccount. Format: accounts/{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").
    • :body (type: GoogleApi.MerchantAPI.Reports_v1beta.Model.SearchRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.MerchantAPI.Reports_v1beta.Model.SearchResponse{}} on success
  • {:error, info} on failure