View Source GoogleApi.CloudChannel.V1.Api.Products (google_api_cloud_channel v0.6.0)

API calls for all endpoints tagged Products.

Summary

Functions

Lists the Products the reseller is authorized to sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.

Lists the SKUs for a product the reseller is authorized to sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.

Functions

Link to this function

cloudchannel_products_list(connection, optional_params \\ [], opts \\ [])

View Source
@spec cloudchannel_products_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok,
   GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1ListProductsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the Products the reseller is authorized to sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • 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").
    • :account (type: String.t) - Required. The resource name of the reseller account. Format: accounts/{account_id}.
    • :languageCode (type: String.t) - Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US".
    • :pageSize (type: integer()) - Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 Products. The maximum value is 1000; the server will coerce values above 1000.
    • :pageToken (type: String.t) - Optional. A token for a page of results other than the first page.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1ListProductsResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
@spec cloudchannel_products_skus_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1ListSkusResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the SKUs for a product the reseller is authorized to sell. Possible error codes: * INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameters

  • connection (type: GoogleApi.CloudChannel.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The resource name of the Product to list SKUs for. Parent uses the format: products/{product_id}. Supports products/- to retrieve SKUs for all products.
  • 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").
    • :account (type: String.t) - Required. Resource name of the reseller. Format: accounts/{account_id}.
    • :languageCode (type: String.t) - Optional. The BCP-47 language code. For example, "en-US". The response will localize in the corresponding language code, if specified. The default value is "en-US".
    • :pageSize (type: integer()) - Optional. Requested page size. Server might return fewer results than requested. If unspecified, returns at most 100 SKUs. The maximum value is 1000; the server will coerce values above 1000.
    • :pageToken (type: String.t) - Optional. A token for a page of results other than the first page. Optional.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudChannel.V1.Model.GoogleCloudChannelV1ListSkusResponse{}} on success
  • {:error, info} on failure