Package google.shopping.merchant.conversions.v1beta

Chỉ mục

ConversionSourcesService

Dịch vụ quản lý các nguồn chuyển đổi cho tài khoản người bán.

CreateConversionSource

rpc CreateConversionSource(CreateConversionSourceRequest) returns (ConversionSource)

Tạo nguồn chuyển đổi mới.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

DeleteConversionSource

rpc DeleteConversionSource(DeleteConversionSourceRequest) returns (Empty)

Lưu trữ nguồn chuyển đổi hiện có. Nếu nguồn chuyển đổi là một Vị trí xuất hiện trong Merchant Center, thì bạn có thể khôi phục nguồn chuyển đổi đó trong 30 ngày. Nếu nguồn chuyển đổi là một Đường liên kết đến Google Analytics, thì nguồn chuyển đổi đó sẽ bị xoá ngay lập tức và bạn có thể khôi phục bằng cách tạo một nguồn mới.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

GetConversionSource

rpc GetConversionSource(GetConversionSourceRequest) returns (ConversionSource)

Tìm nạp một nguồn chuyển đổi.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

ListConversionSources

rpc ListConversionSources(ListConversionSourcesRequest) returns (ListConversionSourcesResponse)

Truy xuất danh sách các nguồn chuyển đổi mà phương thức gọi có quyền truy cập.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

UndeleteConversionSource

rpc UndeleteConversionSource(UndeleteConversionSourceRequest) returns (ConversionSource)

Bật lại nguồn chuyển đổi đã lưu trữ. Chỉ dành cho các nguồn chuyển đổi Đích đến trong Merchant Center.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

UpdateConversionSource

rpc UpdateConversionSource(UpdateConversionSourceRequest) returns (ConversionSource)

Cập nhật thông tin của một nguồn chuyển đổi hiện có. Chỉ dành cho các nguồn chuyển đổi Đích đến trong Merchant Center.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Tổng quan về OAuth 2.0.

AttributionSettings

Biểu thị chế độ cài đặt phân bổ cho các nguồn chuyển đổi nhận dữ liệu phân bổ trước.

Trường
attribution_lookback_window_days

int32

Bắt buộc. Giai đoạn xem lại (tính theo ngày) được dùng cho hoạt động phân bổ trong nguồn này. Các giá trị được hỗ trợ là 7, 30, 40.

attribution_model

AttributionModel

Bắt buộc. Mô hình phân bổ.

conversion_type[]

ConversionType

Không thể thay đổi. Danh sách không theo thứ tự. Danh sách các loại chuyển đổi có thể phân loại sự kiện chuyển đổi. Loại "purchase" tiêu chuẩn sẽ được tạo tự động nếu danh sách này trống tại thời điểm tạo.

AttributionModel

Mô hình phân bổ được sử dụng cho nguồn này. Chúng tôi hỗ trợ cùng một tập hợp mô hình do Google Analytics 4 cung cấp, như mô tả trong: https://support.google.com/analytics/answer/10596866.

Enum
ATTRIBUTION_MODEL_UNSPECIFIED Mô hình chưa được chỉ định.
CROSS_CHANNEL_LAST_CLICK Mô hình Lượt nhấp cuối cùng trên nhiều kênh.
ADS_PREFERRED_LAST_CLICK Mô hình ưu tiên lượt nhấp cuối cùng trên Google Ads.
CROSS_CHANNEL_DATA_DRIVEN Mô hình theo hướng dữ liệu trên nhiều kênh.
CROSS_CHANNEL_FIRST_CLICK Mô hình Lượt nhấp đầu tiên trên nhiều kênh.
CROSS_CHANNEL_LINEAR Mô hình tuyến tính trên nhiều kênh.
CROSS_CHANNEL_POSITION_BASED Mô hình Dựa trên vị trí trên nhiều kênh.
CROSS_CHANNEL_TIME_DECAY Mô hình Giảm dựa trên thời gian trên nhiều kênh.

ConversionType

Thông báo thể hiện một loại sự kiện chuyển đổi

Trường
name

string

Chỉ có đầu ra. Tên sự kiện chuyển đổi, vì khách hàng sẽ báo cáo sự kiện này.

report

bool

Chỉ có đầu ra. Lựa chọn cho biết liệu loại đó có được đưa vào báo cáo Merchant Center hay không.

ConversionSource

Đại diện cho nguồn chuyển đổi do tài khoản người bán sở hữu. Tài khoản người bán có thể có tối đa 200 nguồn chuyển đổi.

Trường
name

string

Chỉ có đầu ra. Giá trị nhận dạng. Do Content API tạo khi tạo ConversionSource mới. Định dạng: [a-z]{4}:.+ Bốn ký tự trước dấu hai chấm biểu thị loại nguồn chuyển đổi. Nội dung sau dấu hai chấm biểu thị mã nhận dạng của nguồn chuyển đổi trong loại đó. Mã của hai nguồn chuyển đổi khác nhau có thể giống nhau trên các loại khác nhau. Các tiền tố loại sau được hỗ trợ: - galk: Đối với các nguồn GoogleAnalyticsLink. – mCDN: Đối với các nguồn MerchantCenterDestination.

state

State

Chỉ có đầu ra. Trạng thái hiện tại của nguồn chuyển đổi này. Không thể chỉnh sửa thông qua API.

expire_time

Timestamp

Chỉ có đầu ra. Thời điểm nguồn chuyển đổi đã lưu trữ bị xoá vĩnh viễn và không còn có sẵn để huỷ xoá.

controller

Controller

Chỉ có đầu ra. Trình kiểm soát nguồn chuyển đổi.

Trường hợp source_data. Bắt buộc. Dữ liệu nguồn chuyển đổi dành riêng cho từng loại nguồn. source_data chỉ có thể là một trong những trạng thái sau:
merchant_center_destination

MerchantCenterDestination

Nguồn chuyển đổi thuộc loại "Đích đến của thẻ Merchant Center".

Trình điều khiển

Thực thể kiểm soát nguồn chuyển đổi.

Enum
CONTROLLER_UNSPECIFIED Giá trị mặc định. Giá trị này không được sử dụng.
MERCHANT Do Người bán sở hữu Nguồn chuyển đổi kiểm soát.
YOUTUBE_AFFILIATES Do chương trình liên kết của YouTube kiểm soát.

Tiểu bang

Thể hiện trạng thái của nguồn chuyển đổi.

Enum
STATE_UNSPECIFIED Nguồn chuyển đổi có trạng thái chưa xác định.
ACTIVE Nguồn chuyển đổi có đầy đủ chức năng.
ARCHIVED Nguồn chuyển đổi đã được lưu trữ trong 30 ngày qua và hiện không hoạt động. Có thể khôi phục bằng cách sử dụng phương pháp huỷ xoá.
PENDING Quá trình tạo nguồn chuyển đổi đã bắt đầu nhưng chưa hoàn tất.

CreateConversionSourceRequest

Thông báo yêu cầu cho phương thức CreateConvertSource.

Trường
parent

string

Bắt buộc. Tài khoản người bán sẽ sở hữu nguồn chuyển đổi mới. Định dạng: accounts/{account}

conversion_source

ConversionSource

Bắt buộc. Nội dung mô tả nguồn chuyển đổi. Một mã mới sẽ tự động được chỉ định cho mã đó khi tạo.

DeleteConversionSourceRequest

Thông báo yêu cầu cho phương pháp DeleteconversionSource.

Trường
name

string

Bắt buộc. Tên của nguồn chuyển đổi cần xoá. Định dạng: accounts/{account}/conversionSources/{conversion_source}

GetConversionSourceRequest

Thông báo yêu cầu cho phương thức GetconversionSource.

Trường
name

string

Bắt buộc. Tên của nguồn chuyển đổi cần tìm nạp. Định dạng: accounts/{account}/conversionsources/{conversion_source}

ListConversionSourcesRequest

Thông báo yêu cầu cho phương thức ListconversionSources.

Trường
parent

string

Bắt buộc. Tài khoản người bán sở hữu tập hợp các nguồn chuyển đổi. Định dạng: accounts/{account}

page_size

int32

Không bắt buộc. Số nguồn chuyển đổi tối đa trả về trong một trang. Nếu bạn không chỉ định page_size, thì 100 sẽ được dùng làm giá trị mặc định. Giá trị tối đa là 200. Các giá trị trên 200 sẽ được ép gán thành 200. Bất kể phân trang, tổng cộng tối đa 200 nguồn chuyển đổi sẽ được trả về.

page_token

string

Không bắt buộc. Mã thông báo trang.

show_deleted

bool

Không bắt buộc. Hiển thị tùy chọn đã xóa (được lưu trữ).

ListConversionSourcesResponse

Thông báo phản hồi cho phương thức ListconversionSources.

Trường
conversion_sources[]

ConversionSource

Danh sách nguồn chuyển đổi.

next_page_token

string

Mã thông báo được sử dụng để tìm nạp trang kết quả tiếp theo.

MerchantCenterDestination

Bạn có thể sử dụng nguồn "Đích đến của Merchant Center" để gửi sự kiện chuyển đổi từ một cửa hàng trực tuyến bằng cách sử dụng thẻ Google trực tiếp đến tài khoản Merchant Center đã tạo nguồn.

Trường
destination

string

Chỉ có đầu ra. Mã đích đến trong Merchant Center.

attribution_settings

AttributionSettings

Bắt buộc. Chế độ cài đặt mô hình phân bổ đang được sử dụng cho Đích đến trong Merchant Center.

display_name

string

Bắt buộc. Tên hiển thị do người bán chỉ định cho vị trí xuất hiện. Đây là tên xác định nguồn chuyển đổi trong giao diện người dùng Merchant Center. Gồm tối đa 64 ký tự.

currency_code

string

Bắt buộc. Mã đơn vị tiền tệ gồm ba chữ cái (ISO 4217). Mã đơn vị tiền tệ xác định đơn vị tiền tệ mà các lượt chuyển đổi được gửi đến vị trí xuất hiện này sẽ được báo cáo trong Merchant Center.

UndeleteConversionSourceRequest

Thông báo yêu cầu cho phương thức UndeleteconversionSource.

Trường
name

string

Bắt buộc. Tên của nguồn chuyển đổi cần được huỷ xoá. Định dạng: accounts/{account}/conversionSources/{conversion_source}

UpdateConversionSourceRequest

Thông báo yêu cầu cho phương pháp UpdateConversionSource.

Trường
conversion_source

ConversionSource

Bắt buộc. Phiên bản mới của dữ liệu nguồn chuyển đổi. Định dạng: accounts/{account}/conversionSources/{conversion_source}

update_mask

FieldMask

Bắt buộc. Danh sách trường đang được cập nhật.