Package google.shopping.merchant.conversions.v1beta

    Index

    ConversionSourcesService

    Service for managing conversion sources for a merchant account.

    CreateConversionSource

    rpc CreateConversionSource( CreateConversionSourceRequest ) returns ( ConversionSource )

    Creates a new conversion source.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/content

    For more information, see the OAuth 2.0 Overview .

    DeleteConversionSource

    rpc DeleteConversionSource( DeleteConversionSourceRequest ) returns ( Empty )

    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.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/content

    For more information, see the OAuth 2.0 Overview .

    GetConversionSource

    rpc GetConversionSource( GetConversionSourceRequest ) returns ( ConversionSource )

    Fetches a conversion source.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/content

    For more information, see the OAuth 2.0 Overview .

    ListConversionSources

    rpc ListConversionSources( ListConversionSourcesRequest ) returns ( ListConversionSourcesResponse )

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

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/content

    For more information, see the OAuth 2.0 Overview .

    UndeleteConversionSource

    rpc UndeleteConversionSource( UndeleteConversionSourceRequest ) returns ( ConversionSource )

    Re-enables an archived conversion source. Only Available for Merchant Center Destination conversion sources.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/content

    For more information, see the OAuth 2.0 Overview .

    UpdateConversionSource

    rpc UpdateConversionSource( UpdateConversionSourceRequest ) returns ( ConversionSource )

    Updates information of an existing conversion source. Available only for Merchant Center Destination conversion sources.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/content

    For more information, see the OAuth 2.0 Overview .

    AttributionSettings

    Represents attribution settings for conversion sources receiving pre-attribution data.

    Fields
    attribution_lookback_window_days

    int32

    Required. Lookback window (in days) used for attribution in this source. Supported values are 7 , 30 & 40 .
    attribution_model

    AttributionModel

    Required. Attribution model.
    conversion_type[]

    ConversionType

    Immutable. Unordered list. List of different conversion types a conversion event can be classified as. A standard "purchase" type will be automatically created if this list is empty at creation time.

    AttributionModel

    The attribution model used for this source. We support the same set of models offered by Google Analytics 4 .

    Enums
    ATTRIBUTION_MODEL_UNSPECIFIED Unspecified model.
    CROSS_CHANNEL_LAST_CLICK Cross-channel Last Click model.
    ADS_PREFERRED_LAST_CLICK Ads-preferred Last Click model.
    CROSS_CHANNEL_DATA_DRIVEN Cross-channel Data Driven model.
    CROSS_CHANNEL_FIRST_CLICK Cross-channel First Click model.
    CROSS_CHANNEL_LINEAR Cross-channel Linear model.
    CROSS_CHANNEL_POSITION_BASED Cross-channel Position Based model.
    CROSS_CHANNEL_TIME_DECAY Cross-channel Time Decay model.

    ConversionType

    Message representing the type of a conversion event.

    Fields
    name

    string

    Output only. Conversion event name, as it'll be reported by the client.
    report

    bool

    Output only. Option indicating if the type should be included in Merchant Center reporting.

    ConversionSource

    Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources.

    Fields
    name

    string

    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 conversion 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.

    state

    State

    Output only. Current state of this conversion source. Can't be edited through the API.

    expire_time

    Timestamp

    Output only. The time when an archived conversion source becomes permanently deleted and is no longer available to undelete.

    controller

    Controller

    Output only. Controller of the conversion source.

    Union field source_data . Required. Conversion source data specific to each different type of source. source_data can be only one of the following:
    merchant_center_destination

    MerchantCenterDestination

    Conversion Source of type "Merchant Center Tag Destination".

    Controller

    Entity controlling the conversion source.

    Enums
    CONTROLLER_UNSPECIFIED Default value. This value is unused.
    MERCHANT Controlled by the Merchant who owns the Conversion Source.
    YOUTUBE_AFFILIATES Controlled by the Youtube Affiliates program.

    State

    Represents the state of a conversion source.

    Enums
    STATE_UNSPECIFIED Conversion source has unspecified state.
    ACTIVE Conversion source is fully functional.
    ARCHIVED Conversion source has been archived in the last 30 days and is currently not functional. Can be restored using the undelete method.
    PENDING Conversion source creation has started but not fully finished yet.

    CreateConversionSourceRequest

    Request message for the CreateConversionSource method.

    Fields
    parent

    string

    Required. The merchant account that will own the new conversion source. Format: accounts/{account}

    conversion_source

    ConversionSource

    Required. The conversion source description. A new ID will be automatically assigned to it upon creation.

    DeleteConversionSourceRequest

    Request message for the DeleteConversionSource method.

    Fields
    name

    string

    Required. The name of the conversion source to be deleted. Format: accounts/{account}/conversionSources/{conversion_source}

    GetConversionSourceRequest

    Request message for the GetConversionSource method.

    Fields
    name

    string

    Required. The name of the conversion source to be fetched. Format: accounts/{account}/conversionSources/{conversion_source}

    ListConversionSourcesRequest

    Request message for the ListConversionSources method.

    Fields
    parent

    string

    Required. The merchant account who owns the collection of conversion sources. Format: accounts/{account}

    page_size

    int32

    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.
    page_token

    string

    Optional. Page token.
    show_deleted

    bool

    Optional. Show deleted (archived) conversion sources. By default, deleted conversion sources are not returned.

    ListConversionSourcesResponse

    Response message for the ListConversionSources method.

    Fields
    conversion_sources[]

    ConversionSource

    List of conversion sources.
    next_page_token

    string

    Token to be used to fetch the next results page.

    MerchantCenterDestination

    "Merchant Center Destination" sources can be used to send conversion events from an online store using a Google tag directly to a Merchant Center account where the source is created.

    Fields
    destination

    string

    Output only. Merchant Center Destination ID.
    attribution_settings

    AttributionSettings

    Required. Attribution settings used for the Merchant Center Destination.
    display_name

    string

    Required. Merchant-specified display name for the destination. This is the name that identifies the conversion source within the Merchant Center UI. The maximum length is 64 characters.
    currency_code

    string

    Required. Three-letter currency code (ISO 4217). The currency code defines in which currency the conversions sent to this destination will be reported in Merchant Center.

    UndeleteConversionSourceRequest

    Request message for the UndeleteConversionSource method.

    Fields
    name

    string

    Required. The name of the conversion source to be undeleted. Format: accounts/{account}/conversionSources/{conversion_source}

    UpdateConversionSourceRequest

    Request message for the UpdateConversionSource method.

    Fields
    conversion_source

    ConversionSource

    Required. The new version of the conversion source data.
    update_mask

    FieldMask

    Optional. List of fields being updated.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: