2024-06-14
▼ ▲ merchantapi.accounts.conversionSources.create
Path: conversions/v1beta/{+parent}/conversionSources
Flat Path: conversions/v1beta/accounts/{accountsId}/conversionSources
HTTP Method: POST
Parameters:
parent
Description: Required. The merchant account that will own the new conversion source. Format: accounts/{account}
Pattern: ^accounts/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/content
Description: Creates a new conversion source.
▼ ▲ merchantapi.accounts.conversionSources.patch
Path: conversions/v1beta/{+name}
Flat Path: conversions/v1beta/accounts/{accountsId}/conversionSources/{conversionSourcesId}
HTTP Method: PATCH
Parameters:
name
Description: Output only. Identifier. Generated by the Content API upon creation of a new `ConversionSource`. Format: [a-z]{4}:.+ The four characters before the colon represent the type of conversio source. Content after the colon represents the ID of the conversion source within that type. The ID of two different conversion sources might be the same across different types. The following type prefixes are supported: - galk: For GoogleAnalyticsLink sources. - mcdn: For MerchantCenterDestination sources.
Pattern: ^accounts/[^/]+/conversionSources/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. List of fields being updated.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Updates information of an existing conversion source. Available only for Merchant Center Destination conversion sources.
▼ ▲ merchantapi.accounts.conversionSources.delete
Path: conversions/v1beta/{+name}
Flat Path: conversions/v1beta/accounts/{accountsId}/conversionSources/{conversionSourcesId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the conversion source to be deleted. Format: accounts/{account}/conversionSources/{conversion_source}
Pattern: ^accounts/[^/]+/conversionSources/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Archives an existing conversion source. If the conversion source is a Merchant Center Destination, it will be recoverable for 30 days. If the conversion source is a Google Analytics Link, it will be deleted immediately and can be restored by creating a new one.
▼ ▲ merchantapi.accounts.conversionSources.undelete
Path: conversions/v1beta/{+name}:undelete
Flat Path: conversions/v1beta/accounts/{accountsId}/conversionSources/{conversionSourcesId}:undelete
HTTP Method: POST
Parameters:
name
Description: Required. The name of the conversion source to be undeleted. Format: accounts/{account}/conversionSources/{conversion_source}
Pattern: ^accounts/[^/]+/conversionSources/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Re-enables an archived conversion source. Only Available for Merchant Center Destination conversion sources.
▼ ▲ merchantapi.accounts.conversionSources.get
Path: conversions/v1beta/{+name}
Flat Path: conversions/v1beta/accounts/{accountsId}/conversionSources/{conversionSourcesId}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the conversion source to be fetched. Format: accounts/{account}/conversionsources/{conversion_source}
Pattern: ^accounts/[^/]+/conversionSources/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Fetches a conversion source.
▼ ▲ merchantapi.accounts.conversionSources.list
Path: conversions/v1beta/{+parent}/conversionSources
Flat Path: conversions/v1beta/accounts/{accountsId}/conversionSources
HTTP Method: GET
Parameters:
parent
Description: Required. The merchant account who owns the collection of conversion sources. Format: accounts/{account}
Pattern: ^accounts/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. 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.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. Page token.
Location: query
Type: string
showDeleted
Description: Optional. Show deleted (archived) option.
Location: query
Type: boolean
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/content
Description: Retrieves the list of conversion sources the caller has access to.