Package google.shopping.merchant.conversions.v1beta

インデックス

ConversionSourcesService

販売者のアカウントのコンバージョン ソースを管理するサービス。

CreateConversionSource

rpc CreateConversionSource(CreateConversionSourceRequest) returns (ConversionSource)

新しいコンバージョン ソースを作成します。

認可スコープ

次の OAuth スコープが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。
DeleteConversionSource

rpc DeleteConversionSource(DeleteConversionSourceRequest) returns (Empty)

既存のコンバージョン ソースをアーカイブします。コンバージョンの発生元が Merchant Center のリンク先の場合、30 日間は復元できます。コンバージョンの発生元が Google アナリティクス リンクの場合は、直ちに削除されます。新しいリンクを作成することで復元できます。

認可スコープ

次の OAuth スコープが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。
GetConversionSource

rpc GetConversionSource(GetConversionSourceRequest) returns (ConversionSource)

コンバージョンの発生元を取得します。

認可スコープ

次の OAuth スコープが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。
ListConversionSources

rpc ListConversionSources(ListConversionSourcesRequest) returns (ListConversionSourcesResponse)

呼び出し元がアクセスできるコンバージョン ソースのリストを取得します。

認可スコープ

次の OAuth スコープが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。
UndeleteConversionSource

rpc UndeleteConversionSource(UndeleteConversionSourceRequest) returns (ConversionSource)

アーカイブしたコンバージョンの発生元を再度有効にします。Merchant Center のリンク先のコンバージョンの発生元でのみ使用できます。

認可スコープ

次の OAuth スコープが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。
UpdateConversionSource

rpc UpdateConversionSource(UpdateConversionSourceRequest) returns (ConversionSource)

既存のコンバージョン ソースの情報を更新します。Merchant Center のリンク先のコンバージョンの発生元でのみ使用できます。

認可スコープ

次の OAuth スコープが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

AttributionSettings

アトリビューション前のデータを受信するコンバージョン ソースのアトリビューション設定を表します。

フィールド
attribution_lookback_window_days

int32

必須。このソースのアトリビューションに使用されるルックバック ウィンドウ（日数）。サポートされている値は 7、30、40 です。
attribution_model

AttributionModel

必須。アトリビューション モデル。
conversion_type[]

ConversionType

変更不可。順序なしリスト。コンバージョン イベントを分類できるコンバージョンの種類のリスト。作成時にこのリストが空の場合、標準の「購入」タイプが自動的に作成されます。

AttributionModel

このソースで使用されているアトリビューション モデル。https://support.google.com/analytics/answer/10596866 に記載されているとおり、Google アナリティクス 4 で提供されているモデルと同じセットがサポートされています。

列挙型
ATTRIBUTION_MODEL_UNSPECIFIED モデルが指定されていません。
CROSS_CHANNEL_LAST_CLICK クロスチャネルのラストクリック モデル。
ADS_PREFERRED_LAST_CLICK Google 広告優先ラストクリック モデル。
CROSS_CHANNEL_DATA_DRIVEN クロスチャネル データドリブン モデル。
CROSS_CHANNEL_FIRST_CLICK クロスチャネル ファースト クリック モデル。
CROSS_CHANNEL_LINEAR クロスチャネル線形モデル。
CROSS_CHANNEL_POSITION_BASED クロスチャネル接点ベースモデル。
CROSS_CHANNEL_TIME_DECAY クロスチャネル減衰モデル。

ConversionType

コンバージョン イベントの種類を表すメッセージ

フィールド
name

string

出力専用。コンバージョン イベント名（クライアントから報告される名前）。
report

bool

出力専用。タイプを Merchant Center レポートに含めるかどうかを示すオプション。

ConversionSource

販売者のアカウントが所有するコンバージョン ソースを表します。販売者のアカウントには、最大 200 個のコンバージョン ソースを設定できます。

フィールド
name

string

出力専用。ID。新しい ConversionSource の作成時に Content API によって生成されます。形式: [a-z]{4}:.+ コロンの前の 4 文字は、コンバージョン ソースのタイプを表します。コロンの後のコンテンツは、そのタイプのコンバージョン ソースの ID を表します。2 つの異なるコンバージョン ソースの ID が、コンバージョン タイプが異なる場合でも同じになることがあります。サポートされているタイプ接頭辞は次のとおりです。- galk: GoogleAnalyticsLink ソース用。- mcdn: MerchantCenterDestination ソースの場合。
state

State

出力専用。このコンバージョン ソースの現在の状態。API では編集できません。
expire_time

Timestamp

出力専用。アーカイブされたコンバージョン ソースが完全に削除され、復元できなくなるまでの時間。
controller

Controller

出力専用。コンバージョンの発生元のコントローラ。
共用体フィールド source_data。必須。ソースの種類ごとに固有のコンバージョン ソース データ。source_data は次のいずれかになります。
merchant_center_destination

MerchantCenterDestination

コンバージョンの発生元が「Merchant Center タグのデスティネーション」タイプである。

コントローラ

コンバージョンの発生元を制御するエンティティ。

列挙型
CONTROLLER_UNSPECIFIED デフォルト値。この値は使用されません。
MERCHANT コンバージョンの発生元を所有する販売者が管理します。
YOUTUBE_AFFILIATES YouTube アフィリエイト プログラムによって管理されます。

州

コンバージョン ソースの状態を表します。

列挙型
STATE_UNSPECIFIED コンバージョン ソースの状態が指定されていません。
ACTIVE コンバージョン ソースが完全に機能している。
ARCHIVED コンバージョン ソースは過去 30 日間にアーカイブされており、現在は機能していません。削除解除メソッドを使用して復元できます。
PENDING コンバージョン ソースの作成は開始されていますが、まだ完全に完了していません。

CreateConversionSourceRequest

CreateConversionSource メソッドのリクエスト メッセージ。

フィールド
parent

string

必須。新しいコンバージョン ソースを所有する販売者アカウント。形式: accounts/{account}
conversion_source

ConversionSource

必須。コンバージョンの発生元の説明。作成時に新しい ID が自動的に割り当てられます。

DeleteConversionSourceRequest

DeleteConversionSource メソッドのリクエスト メッセージ。

フィールド
name

string

必須。削除するコンバージョン ソースの名前。形式: accounts/{account}/conversionSources/{conversion_source}

GetConversionSourceRequest

GetConversionSource メソッドのリクエスト メッセージ。

フィールド
name

string

必須。取得するコンバージョン ソースの名前。形式: accounts/{account}/conversionSources/{conversion_source}

ListConversionSourcesRequest

ListConversionSources メソッドのリクエスト メッセージ。

フィールド
parent

string

必須。コンバージョン ソースのコレクションを所有する販売者のアカウント。形式: accounts/{account}
page_size

int32

省略可。1 ページで返されるコンバージョン ソースの最大数。page_size が指定されていない場合、デフォルト値として 100 が使用されます。最大値は 200 です。200 を超える値は 200 に強制変換されます。ページネーションに関係なく、最大で 200 個のコンバージョン発生元が返されます。
page_token

string

省略可。ページトークン。
show_deleted

bool

省略可。削除済み（アーカイブ済み）のオプションを表示します。

ListConversionSourcesResponse

ListConversionSources メソッドのレスポンス メッセージ。

フィールド
conversion_sources[]

ConversionSource

コンバージョンの発生元のリスト。
next_page_token

string

次の結果ページを取得するために使用するトークン。

MerchantCenterDestination

「Merchant Center のリンク先」の参照元を使用すると、Google タグを使用してオンライン ショップからコンバージョン イベントを、参照元が作成された Merchant Center アカウントに直接送信できます。

フィールド
destination

string

出力専用。Merchant Center のリンク先 ID。
attribution_settings

AttributionSettings

必須。Merchant Center のリンク先で使用されているアトリビューション設定。
display_name

string

必須。販売者が指定した、リンク先の表示名。これは、Merchant Center の UI 内でコンバージョンの発生元を識別するための名前です。64 文字以内で指定します。
currency_code

string

必須。3 文字の通貨コード（ISO 4217）。通貨コードは、このリンク先に送信されたコンバージョンが Merchant Center でどの通貨でレポートされるかを定義します。

UndeleteConversionSourceRequest

UndeleteConversionSource メソッドのリクエスト メッセージ。

フィールド
name

string

必須。削除を解除するコンバージョンの発生元の名前。形式: accounts/{account}/conversionSources/{conversion_source}

UpdateConversionSourceRequest

UpdateConversionSource メソッドのリクエスト メッセージ。

フィールド
conversion_source

ConversionSource

必須。コンバージョンの発生元データの新しいバージョン。形式: accounts/{account}/conversionSources/{conversion_source}
update_mask

FieldMask

省略可。更新されるフィールドのリスト。