View Source GoogleApi.Content.V21.Api.Conversionsources (google_api_content v0.67.1)

API calls for all endpoints tagged Conversionsources.

Summary

Functions

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

Creates a new conversion source.

content_conversionsources_delete(connection, merchant_id, conversion_source_id, optional_params \\ [], opts \\ [])

Archives an existing conversion source. It will be recoverable for 30 days. This archiving behavior is not typical in the Content API and unique to this service.

content_conversionsources_get(connection, merchant_id, conversion_source_id, optional_params \\ [], opts \\ [])

Fetches a conversion source.

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

Retrieves the list of conversion sources the caller has access to.

content_conversionsources_patch(connection, merchant_id, conversion_source_id, optional_params \\ [], opts \\ [])

Updates information of an existing conversion source.

content_conversionsources_undelete(connection, merchant_id, conversion_source_id, optional_params \\ [], opts \\ [])

Re-enables an archived conversion source.

Functions

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

@spec content_conversionsources_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V21.Model.ConversionSource.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new conversion source.

Parameters

connection (type: GoogleApi.Content.V21.Connection.t) - Connection to server
merchant_id (type: String.t) - Required. The ID of the account that owns the new conversion source.
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.Content.V21.Model.ConversionSource.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Content.V21.Model.ConversionSource{}} on success
{:error, info} on failure

content_conversionsources_delete(connection, merchant_id, conversion_source_id, optional_params \\ [], opts \\ [])

@spec content_conversionsources_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Archives an existing conversion source. It will be recoverable for 30 days. This archiving behavior is not typical in the Content API and unique to this service.

Parameters

connection (type: GoogleApi.Content.V21.Connection.t) - Connection to server
merchant_id (type: String.t) - Required. The ID of the account that owns the new conversion source.
conversion_source_id (type: String.t) - Required. The ID of the conversion source to be deleted.
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, %{}} on success
{:error, info} on failure

content_conversionsources_get(connection, merchant_id, conversion_source_id, optional_params \\ [], opts \\ [])

@spec content_conversionsources_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V21.Model.ConversionSource.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Fetches a conversion source.

Parameters

connection (type: GoogleApi.Content.V21.Connection.t) - Connection to server
merchant_id (type: String.t) - Required. The ID of the account that owns the new conversion source.
conversion_source_id (type: String.t) - Required. The REST ID of the collection.
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.Content.V21.Model.ConversionSource{}} on success
{:error, info} on failure

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

@spec content_conversionsources_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V21.Model.ListConversionSourcesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves the list of conversion sources the caller has access to.

Parameters

connection (type: GoogleApi.Content.V21.Connection.t) - Connection to server
merchant_id (type: String.t) - Required. The ID of the account that owns the new conversion source.
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").
- :pageSize (type: integer()) - The maximum number of conversion sources to return in a page. If no page_size is specified, 100 is used as the default value. The maximum value is 200. Values above 200 will be coerced to 200. Regardless of pagination, at most 200 conversion sources are returned in total.
- :pageToken (type: String.t) - Page token.
- :showDeleted (type: boolean()) - If true, also returns archived conversion sources.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Content.V21.Model.ListConversionSourcesResponse{}} on success
{:error, info} on failure

content_conversionsources_patch(connection, merchant_id, conversion_source_id, optional_params \\ [], opts \\ [])

@spec content_conversionsources_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Content.V21.Model.ConversionSource.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates information of an existing conversion source.

Parameters

connection (type: GoogleApi.Content.V21.Connection.t) - Connection to server
merchant_id (type: String.t) - Required. The ID of the account that owns the new conversion source.
conversion_source_id (type: String.t) - Required. The ID of the conversion source to be updated.
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").
- :updateMask (type: String.t) - Required. List of fields being updated.
- :body (type: GoogleApi.Content.V21.Model.ConversionSource.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Content.V21.Model.ConversionSource{}} on success
{:error, info} on failure

content_conversionsources_undelete(connection, merchant_id, conversion_source_id, optional_params \\ [], opts \\ [])

@spec content_conversionsources_undelete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

Re-enables an archived conversion source.

Parameters

connection (type: GoogleApi.Content.V21.Connection.t) - Connection to server
merchant_id (type: String.t) - Required. The ID of the account that owns the new conversion source.
conversion_source_id (type: String.t) - Required. The ID of the conversion source to be undeleted.
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.Content.V21.Model.UndeleteConversionSourceRequest.t) -
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure