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

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

列挙型
ATTRIBUTION_MODEL_UNSPECIFIED モデルが指定されていません。
CROSS_CHANNEL_LAST_CLICK クロスチャネルのラストクリック モデル。
ADS_PREFERRED_LAST_CLICK 広告優先のラストクリック モデル。
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

省略可。ページで返されるコンバージョンの発生元の最大数。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

必須。更新するフィールドのリスト。