Package google.analytics.admin.v1alpha

インデックス

AnalyticsAdminService

Google Analytics Admin API のサービス インターフェース。

AcknowledgeUserDataCollection

rpc AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest) returns (AcknowledgeUserDataCollectionResponse)

指定したプロパティのユーザーデータ収集の利用規約に同意します。

MeasurementProtocolSecret リソースを作成するには、この確認手続きを(Google アナリティクスの UI またはこの API を使用して)完了する必要があります。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
ApproveDisplayVideo360AdvertiserLinkProposal

rpc ApproveDisplayVideo360AdvertiserLinkProposal(ApproveDisplayVideo360AdvertiserLinkProposalRequest) returns (ApproveDisplayVideo360AdvertiserLinkProposalResponse)

DisplayVideo360AdvertiserLinkProposal を承認します。DisplayVideo360AdvertiserLinkProposal が削除され、新しい DisplayVideo360AdvertiserLink が作成されます。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
ArchiveAudience

rpc ArchiveAudience(ArchiveAudienceRequest) returns (Empty)

プロパティのオーディエンスをアーカイブします。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
ArchiveCustomDimension

rpc ArchiveCustomDimension(ArchiveCustomDimensionRequest) returns (Empty)

プロパティのカスタム ディメンションをアーカイブします。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
ArchiveCustomMetric

rpc ArchiveCustomMetric(ArchiveCustomMetricRequest) returns (Empty)

プロパティの CustomMetric をアーカイブします。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
BatchCreateAccessBindings

rpc BatchCreateAccessBindings(BatchCreateAccessBindingsRequest) returns (BatchCreateAccessBindingsResponse)

アカウントまたはプロパティへの複数のアクセス バインディングに関する情報を作成します。

このメソッドはトランザクション メソッドです。いずれかの AccessBinding を作成できない場合、どの AccessBinding も作成されません。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.manage.users
BatchDeleteAccessBindings

rpc BatchDeleteAccessBindings(BatchDeleteAccessBindingsRequest) returns (Empty)

アカウントまたはプロパティへの複数のユーザーのリンクに関する情報を削除します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.manage.users
BatchGetAccessBindings

rpc BatchGetAccessBindings(BatchGetAccessBindingsRequest) returns (BatchGetAccessBindingsResponse)

アカウントまたはプロパティへの複数のアクセス バインディングに関する情報を取得します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.manage.users.readonly
  • https://www.googleapis.com/auth/analytics.manage.users
BatchUpdateAccessBindings

rpc BatchUpdateAccessBindings(BatchUpdateAccessBindingsRequest) returns (BatchUpdateAccessBindingsResponse)

アカウントまたはプロパティへの複数のアクセス バインディングに関する情報を更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.manage.users
CancelDisplayVideo360AdvertiserLinkProposal

rpc CancelDisplayVideo360AdvertiserLinkProposal(CancelDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal)

DisplayVideo360AdvertiserLinkProposal をキャンセルします。キャンセルには、次の 2 つの意味があります。- ディスプレイ&ビデオ 360 から開始された提案を拒否する - Google アナリティクスから開始された提案を取り消す キャンセルされた提案は、最終的には自動的に削除されます。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
CreateAccessBinding

rpc CreateAccessBinding(CreateAccessBindingRequest) returns (AccessBinding)

アカウントまたはプロパティにアクセス バインディングを作成します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.manage.users
CreateAudience

rpc CreateAudience(CreateAudienceRequest) returns (Audience)

オーディエンスを作成します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
CreateCalculatedMetric

rpc CreateCalculatedMetric(CreateCalculatedMetricRequest) returns (CalculatedMetric)

CalculatedMetric を作成します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
CreateChannelGroup

rpc CreateChannelGroup(CreateChannelGroupRequest) returns (ChannelGroup)

ChannelGroup を作成します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
CreateConnectedSiteTag

rpc CreateConnectedSiteTag(CreateConnectedSiteTagRequest) returns (CreateConnectedSiteTagResponse)

ユニバーサル アナリティクス プロパティの接続済みサイトタグを作成します。プロパティごとに作成できる接続済みサイトタグは最大 20 個です。注: この API は GA4 プロパティでは使用できません。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
CreateConversionEvent

rpc CreateConversionEvent(CreateConversionEventRequest) returns (ConversionEvent)

非推奨: 代わりに CreateKeyEvent を使用してください。指定された属性を持つコンバージョン イベントを作成します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
CreateCustomDimension

rpc CreateCustomDimension(CreateCustomDimensionRequest) returns (CustomDimension)

CustomDimension を作成します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
CreateCustomMetric

rpc CreateCustomMetric(CreateCustomMetricRequest) returns (CustomMetric)

CustomMetric を作成します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
CreateDataStream

rpc CreateDataStream(CreateDataStreamRequest) returns (DataStream)

DataStream を作成します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
CreateDisplayVideo360AdvertiserLinkProposal

rpc CreateDisplayVideo360AdvertiserLinkProposal(CreateDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal)

DisplayVideo360AdvertiserLinkProposal を作成します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
CreateEventCreateRule

rpc CreateEventCreateRule(CreateEventCreateRuleRequest) returns (EventCreateRule)

EventCreateRule を作成します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
CreateEventEditRule

rpc CreateEventEditRule(CreateEventEditRuleRequest) returns (EventEditRule)

EventEditRule を作成します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
CreateExpandedDataSet

rpc CreateExpandedDataSet(CreateExpandedDataSetRequest) returns (ExpandedDataSet)

ExpandedDataSet を作成します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
CreateKeyEvent

rpc CreateKeyEvent(CreateKeyEventRequest) returns (KeyEvent)

キーイベントを作成します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
CreateMeasurementProtocolSecret

rpc CreateMeasurementProtocolSecret(CreateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

Measurement Protocol シークレットを作成します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
CreateProperty

rpc CreateProperty(CreatePropertyRequest) returns (Property)

指定されたロケーションと属性を持つ Google アナリティクスのプロパティを作成します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
CreateReportingDataAnnotation

rpc CreateReportingDataAnnotation(CreateReportingDataAnnotationRequest) returns (ReportingDataAnnotation)

レポート データのアノテーションを作成します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
CreateRollupProperty

rpc CreateRollupProperty(CreateRollupPropertyRequest) returns (CreateRollupPropertyResponse)

統合プロパティと、統合プロパティのすべての参照元リンクを作成します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
CreateSKAdNetworkConversionValueSchema

rpc CreateSKAdNetworkConversionValueSchema(CreateSKAdNetworkConversionValueSchemaRequest) returns (SKAdNetworkConversionValueSchema)

SKAdNetworkConversionValueSchema を作成します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
CreateSubpropertyEventFilter

rpc CreateSubpropertyEventFilter(CreateSubpropertyEventFilterRequest) returns (SubpropertyEventFilter)

サブプロパティのイベント フィルタを作成します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
DeleteAccessBinding

rpc DeleteAccessBinding(DeleteAccessBindingRequest) returns (Empty)

アカウントまたはプロパティのアクセス バインディングを削除します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.manage.users
DeleteAccount

rpc DeleteAccount(DeleteAccountRequest) returns (Empty)

ターゲット アカウントをソフト削除(「ゴミ箱に移動」)としてマークし、返します。

この API には、削除済みとしてマークされたアカウントを復元するメソッドはありません。ただし、ゴミ箱 UI を使用して復元できます。

アカウントが有効期限までに復元されなかった場合、アカウントとすべての子リソース(プロパティ、GoogleAdsLinks、ストリーム、AccessBindings など)は完全にパージされます。https://support.google.com/analytics/answer/6154772

ターゲットが見つからない場合はエラーが返されます。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
DeleteCalculatedMetric

rpc DeleteCalculatedMetric(DeleteCalculatedMetricRequest) returns (Empty)

プロパティの CalculatedMetric を削除します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
DeleteChannelGroup

rpc DeleteChannelGroup(DeleteChannelGroupRequest) returns (Empty)

プロパティの ChannelGroup を削除します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
DeleteConnectedSiteTag

rpc DeleteConnectedSiteTag(DeleteConnectedSiteTagRequest) returns (Empty)

ユニバーサル アナリティクス プロパティの接続済みのサイトタグを削除します。注: これは GA4 プロパティには影響しません。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
DeleteConversionEvent

rpc DeleteConversionEvent(DeleteConversionEventRequest) returns (Empty)

非推奨: 代わりに DeleteKeyEvent を使用してください。プロパティ内のコンバージョン イベントを削除します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
DeleteDataStream

rpc DeleteDataStream(DeleteDataStreamRequest) returns (Empty)

プロパティのデータストリームを削除します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
DeleteDisplayVideo360AdvertiserLinkProposal

rpc DeleteDisplayVideo360AdvertiserLinkProposal(DeleteDisplayVideo360AdvertiserLinkProposalRequest) returns (Empty)

プロパティの DisplayVideo360AdvertiserLinkProposal を削除します。これは、キャンセルされた提案でのみ使用できます。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
DeleteEventCreateRule

rpc DeleteEventCreateRule(DeleteEventCreateRuleRequest) returns (Empty)

EventCreateRule を削除します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
DeleteEventEditRule

rpc DeleteEventEditRule(DeleteEventEditRuleRequest) returns (Empty)

EventEditRule を削除します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
DeleteExpandedDataSet

rpc DeleteExpandedDataSet(DeleteExpandedDataSetRequest) returns (Empty)

プロパティの ExpandedDataSet を削除します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
DeleteKeyEvent

rpc DeleteKeyEvent(DeleteKeyEventRequest) returns (Empty)

キーイベントを削除します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
DeleteMeasurementProtocolSecret

rpc DeleteMeasurementProtocolSecret(DeleteMeasurementProtocolSecretRequest) returns (Empty)

ターゲットの MeasurementProtocolSecret を削除します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
DeleteProperty

rpc DeleteProperty(DeletePropertyRequest) returns (Property)

ターゲット プロパティを削除済み(「ゴミ箱に移動」)としてマークし、返します。

この API には、削除済み(復元可能)プロパティを復元するメソッドがありません。ただし、ゴミ箱 UI を使用して復元できます。

有効期限までにプロパティが復元されなかった場合、プロパティとすべての子リソース(GoogleAdsLinks、ストリーム、AccessBindings など)は完全にパージされます。https://support.google.com/analytics/answer/6154772

ターゲットが見つからない場合はエラーが返されます。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
DeleteReportingDataAnnotation

rpc DeleteReportingDataAnnotation(DeleteReportingDataAnnotationRequest) returns (Empty)

レポート データのアノテーションを削除します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
DeleteSKAdNetworkConversionValueSchema

rpc DeleteSKAdNetworkConversionValueSchema(DeleteSKAdNetworkConversionValueSchemaRequest) returns (Empty)

ターゲットの SKAdNetworkConversionValueSchema を削除します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
DeleteSubpropertyEventFilter

rpc DeleteSubpropertyEventFilter(DeleteSubpropertyEventFilterRequest) returns (Empty)

サブプロパティ イベント フィルタを削除します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
FetchAutomatedGa4ConfigurationOptOut

rpc FetchAutomatedGa4ConfigurationOptOut(FetchAutomatedGa4ConfigurationOptOutRequest) returns (FetchAutomatedGa4ConfigurationOptOutResponse)

UA プロパティの GA4 自動設定プロセスのオプトアウト ステータスを取得します。注: これは GA4 プロパティには影響しません。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
FetchConnectedGa4Property

rpc FetchConnectedGa4Property(FetchConnectedGa4PropertyRequest) returns (FetchConnectedGa4PropertyResponse)

指定された UA プロパティに関連付けられている GA4 プロパティを検索します。注: GA4 プロパティでは使用できません。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetAccessBinding

rpc GetAccessBinding(GetAccessBindingRequest) returns (AccessBinding)

アクセス バインディングに関する情報を取得します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.manage.users.readonly
  • https://www.googleapis.com/auth/analytics.manage.users
GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

1 つのアカウントを検索します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetAttributionSettings

rpc GetAttributionSettings(GetAttributionSettingsRequest) returns (AttributionSettings)

AttributionSettings シングルトンを検索します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetAudience

rpc GetAudience(GetAudienceRequest) returns (Audience)

単一のオーディエンスの検索。2020 年より前に作成されたオーディエンスはサポートされていない可能性があります。デフォルト オーディエンスにはフィルタ定義は表示されません。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetCalculatedMetric

rpc GetCalculatedMetric(GetCalculatedMetricRequest) returns (CalculatedMetric)

単一の計算指標を検索します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetChannelGroup

rpc GetChannelGroup(GetChannelGroupRequest) returns (ChannelGroup)

単一の ChannelGroup を検索します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetConversionEvent

rpc GetConversionEvent(GetConversionEventRequest) returns (ConversionEvent)

非推奨: 代わりに GetKeyEvent を使用してください。1 つのコンバージョン イベントを取得します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetCustomDimension

rpc GetCustomDimension(GetCustomDimensionRequest) returns (CustomDimension)

単一のカスタム ディメンションを検索します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetCustomMetric

rpc GetCustomMetric(GetCustomMetricRequest) returns (CustomMetric)

単一の CustomMetric を検索します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetDataRedactionSettings

rpc GetDataRedactionSettings(GetDataRedactionSettingsRequest) returns (DataRedactionSettings)

単一の DataRedactionSettings を検索します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetDataRetentionSettings

rpc GetDataRetentionSettings(GetDataRetentionSettingsRequest) returns (DataRetentionSettings)

このプロパティのシングルトン データ保持設定を返します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetDataSharingSettings

rpc GetDataSharingSettings(GetDataSharingSettingsRequest) returns (DataSharingSettings)

アカウントのデータ共有設定を取得します。データ共有設定はシングルトンです。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetDataStream

rpc GetDataStream(GetDataStreamRequest) returns (DataStream)

単一の DataStream を検索します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetDisplayVideo360AdvertiserLinkProposal

rpc GetDisplayVideo360AdvertiserLinkProposal(GetDisplayVideo360AdvertiserLinkProposalRequest) returns (DisplayVideo360AdvertiserLinkProposal)

単一の DisplayVideo360AdvertiserLinkProposal を検索します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetEnhancedMeasurementSettings

rpc GetEnhancedMeasurementSettings(GetEnhancedMeasurementSettingsRequest) returns (EnhancedMeasurementSettings)

このデータ ストリームの拡張計測設定を返します。これらの設定が有効になるには、ストリームで拡張計測が有効になっている必要があります。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetEventCreateRule

rpc GetEventCreateRule(GetEventCreateRuleRequest) returns (EventCreateRule)

単一の EventCreateRule を検索します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetEventEditRule

rpc GetEventEditRule(GetEventEditRuleRequest) returns (EventEditRule)

単一の EventEditRule を検索します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetExpandedDataSet

rpc GetExpandedDataSet(GetExpandedDataSetRequest) returns (ExpandedDataSet)

単一の ExpandedDataSet を検索します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetGlobalSiteTag

rpc GetGlobalSiteTag(GetGlobalSiteTagRequest) returns (GlobalSiteTag)

指定されたウェブ ストリームのサイトタグを返します。サイトタグは不変のシングルトンです。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetGoogleSignalsSettings

rpc GetGoogleSignalsSettings(GetGoogleSignalsSettingsRequest) returns (GoogleSignalsSettings)

プロパティの Google シグナルの設定を検索します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetKeyEvent

rpc GetKeyEvent(GetKeyEventRequest) returns (KeyEvent)

1 つのキーイベントを取得します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetMeasurementProtocolSecret

rpc GetMeasurementProtocolSecret(GetMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

単一の MeasurementProtocolSecret を検索します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetProperty

rpc GetProperty(GetPropertyRequest) returns (Property)

単一の GA プロパティを検索します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetReportingDataAnnotation

rpc GetReportingDataAnnotation(GetReportingDataAnnotationRequest) returns (ReportingDataAnnotation)

単一のレポートデータ アノテーションを検索します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetSKAdNetworkConversionValueSchema

rpc GetSKAdNetworkConversionValueSchema(GetSKAdNetworkConversionValueSchemaRequest) returns (SKAdNetworkConversionValueSchema)

単一の SKAdNetworkConversionValueSchema を検索します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetSubpropertyEventFilter

rpc GetSubpropertyEventFilter(GetSubpropertyEventFilterRequest) returns (SubpropertyEventFilter)

単一のサブプロパティのイベント フィルタを検索します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
GetSubpropertySyncConfig

rpc GetSubpropertySyncConfig(GetSubpropertySyncConfigRequest) returns (SubpropertySyncConfig)

単一の SubpropertySyncConfig を検索します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListAccessBindings

rpc ListAccessBindings(ListAccessBindingsRequest) returns (ListAccessBindingsResponse)

アカウントまたはプロパティのすべてのアクセス バインディングを一覧表示します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.manage.users.readonly
  • https://www.googleapis.com/auth/analytics.manage.users
ListAccountSummaries

rpc ListAccountSummaries(ListAccountSummariesRequest) returns (ListAccountSummariesResponse)

呼び出し元がアクセスできるすべてのアカウントの概要を返します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

呼び出し元がアクセスできるすべてのアカウントを返します。

なお、これらのアカウントには現在、Google アナリティクス プロパティが設定されていない場合があります。削除済み(復元可能)(「ゴミ箱に移動」)のアカウントは、デフォルトで除外されます。関連するアカウントが見つからない場合、空のリストが返されます。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListAudiences

rpc ListAudiences(ListAudiencesRequest) returns (ListAudiencesResponse)

プロパティのオーディエンスを一覧表示します。2020 年より前に作成されたオーディエンスはサポートされていない可能性があります。デフォルト オーディエンスにはフィルタ定義は表示されません。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListCalculatedMetrics

rpc ListCalculatedMetrics(ListCalculatedMetricsRequest) returns (ListCalculatedMetricsResponse)

プロパティの CalculatedMetrics を一覧表示します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListChannelGroups

rpc ListChannelGroups(ListChannelGroupsRequest) returns (ListChannelGroupsResponse)

プロパティの ChannelGroups を一覧表示します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListConnectedSiteTags

rpc ListConnectedSiteTags(ListConnectedSiteTagsRequest) returns (ListConnectedSiteTagsResponse)

ユニバーサル アナリティクス プロパティの接続済みのサイトタグを一覧表示します。返される接続済みのサイトタグの最大数は 20 個です。注: これは GA4 プロパティには影響しません。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListConversionEvents

rpc ListConversionEvents(ListConversionEventsRequest) returns (ListConversionEventsResponse)

非推奨: 代わりに ListKeyEvents を使用してください。指定した親プロパティのコンバージョン イベントのリストを返します。

コンバージョン イベントが見つからない場合、空のリストが返されます。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListCustomDimensions

rpc ListCustomDimensions(ListCustomDimensionsRequest) returns (ListCustomDimensionsResponse)

プロパティの CustomDimensions を一覧表示します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListCustomMetrics

rpc ListCustomMetrics(ListCustomMetricsRequest) returns (ListCustomMetricsResponse)

プロパティの CustomMetrics を一覧表示します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListDataStreams

rpc ListDataStreams(ListDataStreamsRequest) returns (ListDataStreamsResponse)

プロパティの DataStream を一覧表示します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListDisplayVideo360AdvertiserLinkProposals

rpc ListDisplayVideo360AdvertiserLinkProposals(ListDisplayVideo360AdvertiserLinkProposalsRequest) returns (ListDisplayVideo360AdvertiserLinkProposalsResponse)

プロパティの DisplayVideo360AdvertiserLinkProposals を一覧表示します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListEventCreateRules

rpc ListEventCreateRules(ListEventCreateRulesRequest) returns (ListEventCreateRulesResponse)

ウェブデータ ストリームの EventCreateRule を一覧表示します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListEventEditRules

rpc ListEventEditRules(ListEventEditRulesRequest) returns (ListEventEditRulesResponse)

ウェブデータ ストリームの EventEditRules を一覧表示します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListExpandedDataSets

rpc ListExpandedDataSets(ListExpandedDataSetsRequest) returns (ListExpandedDataSetsResponse)

プロパティの ExpandedDataSet を一覧表示します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListKeyEvents

rpc ListKeyEvents(ListKeyEventsRequest) returns (ListKeyEventsResponse)

指定された親プロパティ内の Key Events のリストを返します。キーイベントが見つからない場合、空のリストが返されます。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListMeasurementProtocolSecrets

rpc ListMeasurementProtocolSecrets(ListMeasurementProtocolSecretsRequest) returns (ListMeasurementProtocolSecretsResponse)

指定された親プロパティの下の子 MeasurementProtocolSecret を返します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListProperties

rpc ListProperties(ListPropertiesRequest) returns (ListPropertiesResponse)

指定した親アカウントの子プロパティを返します。

呼び出し元にアクセス権がない場合、プロパティは除外されます。削除済み(復元可能)(「ゴミ箱に移動済み」)の宿泊施設は、デフォルトで除外されます。関連するプロパティが見つからない場合は、空のリストが返されます。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListReportingDataAnnotations

rpc ListReportingDataAnnotations(ListReportingDataAnnotationsRequest) returns (ListReportingDataAnnotationsResponse)

プロパティのすべてのレポートデータ アノテーションを一覧表示します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListSKAdNetworkConversionValueSchemas

rpc ListSKAdNetworkConversionValueSchemas(ListSKAdNetworkConversionValueSchemasRequest) returns (ListSKAdNetworkConversionValueSchemasResponse)

ストリームの SKAdNetworkConversionValueSchema を一覧表示します。プロパティに設定できる SKAdNetworkConversionValueSchema は 1 つまでです。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListSubpropertyEventFilters

rpc ListSubpropertyEventFilters(ListSubpropertyEventFiltersRequest) returns (ListSubpropertyEventFiltersResponse)

プロパティのサブプロパティ イベント フィルタをすべて一覧表示します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ListSubpropertySyncConfigs

rpc ListSubpropertySyncConfigs(ListSubpropertySyncConfigsRequest) returns (ListSubpropertySyncConfigsResponse)

プロパティのすべての SubpropertySyncConfig リソースを一覧表示します。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
ProvisionAccountTicket

rpc ProvisionAccountTicket(ProvisionAccountTicketRequest) returns (ProvisionAccountTicketResponse)

アカウントの作成に関するチケットをリクエストします。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
ProvisionSubproperty

rpc ProvisionSubproperty(ProvisionSubpropertyRequest) returns (ProvisionSubpropertyResponse)

サブプロパティと、作成したサブプロパティに適用するサブプロパティ イベント フィルタを作成します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
ReorderEventEditRules

rpc ReorderEventEditRules(ReorderEventEditRulesRequest) returns (Empty)

指定したストリームのイベント編集ルールの処理順序を変更します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
RunAccessReport

rpc RunAccessReport(RunAccessReportRequest) returns (RunAccessReportResponse)

データアクセス レコードのカスタマイズされたレポートを返します。このレポートには、ユーザーが Google アナリティクスのレポートデータを読み取るたびに記録が残ります。アクセス レコードは最大 2 年間保持されます。

データ アクセス レポートはプロパティに対してリクエストできます。レポートは任意のプロパティに対してリクエストできますが、割り当てに関連しないディメンションは Google アナリティクス 360 プロパティでのみリクエストできます。この方法は管理者のみが利用できます。

これらのデータアクセス レコードには、GA UI レポート、GA UI データ探索、GA Data API など、リンクを介して Google アナリティクスからデータを取得できる Firebase や AdMob などのプロダクトが含まれます。これらのレコードには、ストリームの追加やプロパティのタイムゾーンの変更など、プロパティの構成変更は含まれません。構成変更履歴については、searchChangeHistoryEvents をご覧ください。

この API に関するフィードバックをお寄せいただくには、Google アナリティクス アクセス レポートのフィードバック フォームにご記入ください。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit
SearchChangeHistoryEvents

rpc SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest) returns (SearchChangeHistoryEventsResponse)

指定された一連のフィルタに基づいて、アカウントまたはその子に対するすべての変更を検索します。

API でサポートされている変更のサブセットのみを返します。UI には、追加の変更が返される場合があります。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
SetAutomatedGa4ConfigurationOptOut

rpc SetAutomatedGa4ConfigurationOptOut(SetAutomatedGa4ConfigurationOptOutRequest) returns (SetAutomatedGa4ConfigurationOptOutResponse)

UA プロパティの GA4 自動設定プロセスのオプトアウト ステータスを設定します。注: これは GA4 プロパティには影響しません。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
SubmitUserDeletion

rpc SubmitUserDeletion(SubmitUserDeletionRequest) returns (SubmitUserDeletionResponse)

宿泊施設のユーザーの削除リクエストを送信します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateAccessBinding

rpc UpdateAccessBinding(UpdateAccessBindingRequest) returns (AccessBinding)

アカウントまたはプロパティのアクセス バインディングを更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.manage.users
UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

アカウントを更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateAttributionSettings

rpc UpdateAttributionSettings(UpdateAttributionSettingsRequest) returns (AttributionSettings)

プロパティのアトリビューション設定を更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateAudience

rpc UpdateAudience(UpdateAudienceRequest) returns (Audience)

プロパティのオーディエンスを更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateCalculatedMetric

rpc UpdateCalculatedMetric(UpdateCalculatedMetricRequest) returns (CalculatedMetric)

プロパティの CalculatedMetric を更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateChannelGroup

rpc UpdateChannelGroup(UpdateChannelGroupRequest) returns (ChannelGroup)

ChannelGroup を更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateConversionEvent

rpc UpdateConversionEvent(UpdateConversionEventRequest) returns (ConversionEvent)

非推奨: 代わりに UpdateKeyEvent を使用してください。指定した属性でコンバージョン イベントを更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateCustomDimension

rpc UpdateCustomDimension(UpdateCustomDimensionRequest) returns (CustomDimension)

プロパティのカスタム ディメンションを更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateCustomMetric

rpc UpdateCustomMetric(UpdateCustomMetricRequest) returns (CustomMetric)

プロパティのカスタム指標を更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateDataRedactionSettings

rpc UpdateDataRedactionSettings(UpdateDataRedactionSettingsRequest) returns (DataRedactionSettings)

プロパティの DataRedactionSettings を更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateDataRetentionSettings

rpc UpdateDataRetentionSettings(UpdateDataRetentionSettingsRequest) returns (DataRetentionSettings)

このプロパティのシングルトン データ保持設定を更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateDataStream

rpc UpdateDataStream(UpdateDataStreamRequest) returns (DataStream)

プロパティの DataStream を更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateEnhancedMeasurementSettings

rpc UpdateEnhancedMeasurementSettings(UpdateEnhancedMeasurementSettingsRequest) returns (EnhancedMeasurementSettings)

このデータ ストリームの拡張計測設定を更新します。これらの設定が有効になるには、ストリームで拡張計測が有効になっている必要があります。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateEventCreateRule

rpc UpdateEventCreateRule(UpdateEventCreateRuleRequest) returns (EventCreateRule)

EventCreateRule を更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateEventEditRule

rpc UpdateEventEditRule(UpdateEventEditRuleRequest) returns (EventEditRule)

EventEditRule を更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateExpandedDataSet

rpc UpdateExpandedDataSet(UpdateExpandedDataSetRequest) returns (ExpandedDataSet)

プロパティの ExpandedDataSet を更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateGoogleSignalsSettings

rpc UpdateGoogleSignalsSettings(UpdateGoogleSignalsSettingsRequest) returns (GoogleSignalsSettings)

プロパティの Google シグナルの設定を更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateKeyEvent

rpc UpdateKeyEvent(UpdateKeyEventRequest) returns (KeyEvent)

キーイベントを更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateMeasurementProtocolSecret

rpc UpdateMeasurementProtocolSecret(UpdateMeasurementProtocolSecretRequest) returns (MeasurementProtocolSecret)

測定プロトコルのシークレットを更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateProperty

rpc UpdateProperty(UpdatePropertyRequest) returns (Property)

プロパティを更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateReportingDataAnnotation

rpc UpdateReportingDataAnnotation(UpdateReportingDataAnnotationRequest) returns (ReportingDataAnnotation)

レポート データ アノテーションを更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateSKAdNetworkConversionValueSchema

rpc UpdateSKAdNetworkConversionValueSchema(UpdateSKAdNetworkConversionValueSchemaRequest) returns (SKAdNetworkConversionValueSchema)

SKAdNetworkConversionValueSchema を更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateSubpropertyEventFilter

rpc UpdateSubpropertyEventFilter(UpdateSubpropertyEventFilterRequest) returns (SubpropertyEventFilter)

サブプロパティのイベント フィルタを更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit
UpdateSubpropertySyncConfig

rpc UpdateSubpropertySyncConfig(UpdateSubpropertySyncConfigRequest) returns (SubpropertySyncConfig)

SubpropertySyncConfig を更新します。

認可スコープ

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

  • https://www.googleapis.com/auth/analytics.edit

AccessBetweenFilter

結果が 2 つの数値の範囲内にある必要があることを表します。

フィールド
from_value

NumericValue

この番号で始まります。

to_value

NumericValue

この番号で終わる。

AccessBinding

ユーザーとロールのセットとのバインディング。

フィールド
name

string

出力専用。このバインディングのリソース名。

形式: accounts/{account}/accessBindings/{access_binding} または properties/{property}/accessBindings/{access_binding}

例: "accounts/100/accessBindings/200"

roles[]

string

親リソースに付与するロールのリスト。

有効な値: predefinedRoles/viewer、predefinedRoles/analyst、predefinedRoles/editor、predefinedRoles/admin、predefinedRoles/no-cost-data、predefinedRoles/no-revenue-data

ユーザーの場合、ロールの空のリストが設定されていると、この AccessBinding は削除されます。

共用体フィールド access_target。ロールを設定するターゲット。access_target は次のいずれかになります。
user

string

設定されている場合は、ロールを設定するユーザーのメールアドレス。形式: "someuser@gmail.com"

AccessDateRange

連続した日付の範囲: startDate、startDate + 1、...、endDate。

フィールド
start_date

string

クエリの開始日(この値を含む)。YYYY-MM-DD 形式で指定します。endDate より後の日付は指定できません。形式 NdaysAgoyesterdaytoday も使用できます。この場合、日付はリクエストのタイムゾーンの現在の時刻に基づいて推測されます。

end_date

string

クエリの終了日(その日付を含む)。形式は YYYY-MM-DD です。startDate より前の日付は指定できません。形式 NdaysAgoyesterdaytoday も使用できます。この場合、日付はリクエストのタイムゾーンの現在の時刻に基づいて推測されます。

AccessDimension

ディメンションはデータの属性です。たとえば、ディメンション userEmail は、レポートデータにアクセスしたユーザーのメールアドレスを示します。レポート レスポンスのディメンション値は文字列です。

フィールド
dimension_name

string

ディメンションの API 名。この API でサポートされているディメンションのリストについては、データアクセス スキーマをご覧ください。

ディメンションは、dimensionFilterorderBys で名前で参照されます。

AccessDimensionHeader

レポートのディメンション列を記述します。レポートでリクエストされたディメンションにより、行内の列エントリと DimensionHeader が生成されます。ただし、フィルタまたは式内でのみ使用されるディメンションは、レポートに列を生成しません。また、ヘッダーも生成されません。

フィールド
dimension_name

string

ディメンション名(例: userEmail)。

AccessDimensionValue

ディメンションの値。

フィールド
value

string

ディメンションの値。たとえば、この値は「country」ディメンションの「France」になります。

AccessFilter

ディメンション値または指標値をフィルタする式。

フィールド
field_name

string

ディメンション名または指標名。

共用体フィールド one_filterFilter に 1 種類のフィルタを指定します。one_filter は次のいずれかになります。
string_filter

AccessStringFilter

文字列関連のフィルタ。

in_list_filter

AccessInListFilter

リスト値のフィルタ。

numeric_filter

AccessNumericFilter

数値または日付の値のフィルタ。

between_filter

AccessBetweenFilter

2 つの値のフィルタ。

AccessFilterExpression

ディメンションまたは指標のフィルタを表現します。同じ式内のフィールドは、すべてディメンションか、すべて指標のいずれかにする必要があります。

フィールド
共用体フィールド one_expressionFilterExpression に 1 つのタイプのフィルタ式を指定します。one_expression は次のいずれかになります。
and_group

AccessFilterExpressionList

and_group 内の各 FilterExpression には AND の関係があります。

or_group

AccessFilterExpressionList

or_group 内の各 FilterExpression は OR の関係にあります。

not_expression

AccessFilterExpression

FilterExpression が not_expression ではありません。

access_filter

AccessFilter

プリミティブ フィルタ。同じ FilterExpression で、フィルタのフィールド名がすべてディメンションか、すべて指標のいずれかである必要があります。

AccessFilterExpressionList

フィルタ式のリスト。

フィールド
expressions[]

AccessFilterExpression

フィルタ式のリスト。

AccessInListFilter

結果は文字列値のリストにする必要があります。

フィールド
values[]

string

文字列値のリスト。空でない必要があります。

case_sensitive

bool

true の場合、文字列値は大文字と小文字が区別されます。

AccessMetric

レポートの定量的な測定値。たとえば、指標 accessCount はデータアクセス レコードの合計数です。

フィールド
metric_name

string

指標の API 名。この API でサポートされている指標の一覧については、データアクセス スキーマをご覧ください。

指標は metricFilterorderBys で名前で参照されます。

AccessMetricHeader

レポートの指標列を記述します。レポートでリクエストされた表示可能な指標は、行内の列エントリと MetricHeader に生成されます。ただし、フィルタまたは式内でのみ使用される指標は、レポートに列を生成しません。また、ヘッダーも生成されません。

フィールド
metric_name

string

指標の名前(例: accessCount)。

AccessMetricValue

指標の値。

フィールド
value

string

測定値。たとえば、この値は「13」に設定できます。

AccessNumericFilter

数値または日付の値のフィルタ。

フィールド
operation

Operation

このフィルタのオペレーション タイプ。

value

NumericValue

数値または日付値。

オペレーション

数値フィルタに適用される演算子。

列挙型
OPERATION_UNSPECIFIED (指定なし)
EQUAL 等しい
LESS_THAN 次より小さい
LESS_THAN_OR_EQUAL 次の値以下
GREATER_THAN 次の値を上回る
GREATER_THAN_OR_EQUAL 以上

AccessOrderBy

順序指定では、レスポンスで行を並べ替える方法を定義します。たとえば、アクセス数の降順で並べ替える順序と、国文字列で並べ替える順序は異なります。

フィールド
desc

bool

true の場合、降順で並べ替えます。false または未指定の場合、昇順で並べ替えられます。

共用体フィールド one_order_byOrderBy に 1 つの並べ替え順序を指定します。one_order_by は次のいずれかになります。
metric

MetricOrderBy

結果を指標の値で並べ替えます。

dimension

DimensionOrderBy

結果をディメンションの値で並べ替えます。

DimensionOrderBy

ディメンションの値で並べ替えます。

フィールド
dimension_name

string

並べ替えるリクエスト内のディメンション名。

order_type

OrderType

ディメンション値の並べ替えのルールを制御します。

OrderType

文字列ディメンションの値を並べ替えるルール。

列挙型
ORDER_TYPE_UNSPECIFIED (指定なし)
ALPHANUMERIC 英数字は Unicode コードポイントで並べ替えられます。たとえば、「2」<「A」<「X」<「b」<「z」です。
CASE_INSENSITIVE_ALPHANUMERIC 大文字と小文字を区別しない英数字の並べ替え。小文字の Unicode コードポイントで並べ替えます。たとえば、「2」<「A」<「b」<「X」<「z」です。
NUMERIC ディメンション値は、並べ替える前に数値に変換されます。たとえば、数値の並べ替えでは「25」<「100」ですが、ALPHANUMERIC の並べ替えでは「100」<「25」です。数値以外のディメンション値はすべて、すべての数値の下に同じ並べ替え値が割り当てられます。

MetricOrderBy

指標の値で並べ替えます。

フィールド
metric_name

string

並べ替えるリクエスト内の指標名。

AccessQuota

このアナリティクス プロパティのすべての割り当ての現在の状態。プロパティの割り当てが使い果たされると、そのプロパティに対するすべてのリクエストでリソース不足エラーが返されます。

フィールド
tokens_per_day

AccessQuotaStatus

プロパティは 1 日あたり 250,000 トークンを使用できます。ほとんどの場合、リクエストで使用するトークンは 10 個未満です。

tokens_per_hour

AccessQuotaStatus

プロパティは 1 時間あたり 50,000 トークンを使用できます。API リクエストで消費されるトークン数は 1 つで、その数は 1 時間あたり、1 日あたり、プロジェクトごとの 1 時間あたりの割り当てから差し引かれます。

concurrent_requests

AccessQuotaStatus

プロパティで同時に使用できるリクエストは最大 50 件です。

server_errors_per_project_per_hour

AccessQuotaStatus

プロパティと Cloud プロジェクトのペアで発生するサーバーエラーは、1 時間あたり最大 50 件です。

tokens_per_project_per_hour

AccessQuotaStatus

プロパティは、プロジェクトごとに 1 時間あたりトークンの最大 25% を使用できます。つまり、アナリティクス 360 プロパティでは、プロジェクトごとに 1 時間あたり 12,500 個のトークンを使用できます。API リクエストで消費されるトークン数は 1 つで、その数は 1 時間あたり、1 日あたり、プロジェクトごとの 1 時間あたりの割り当てから差し引かれます。

AccessQuotaStatus

特定の割り当てグループの現在の状態。

フィールド
consumed

int32

このリクエストで消費された割り当て。

remaining

int32

このリクエスト後に残る割り当て。

AccessRow

各行のレポートデータにアクセスします。

フィールド
dimension_values[]

AccessDimensionValue

ディメンション値のリスト。これらの値は、リクエストで指定された順序で返されます。

metric_values[]

AccessMetricValue

指標値のリスト。これらの値は、リクエストで指定された順序で返されます。

AccessStringFilter

文字列のフィルタ。

フィールド
match_type

MatchType

このフィルタのマッチタイプ。

value

string

照合に使用される文字列値。

case_sensitive

bool

true の場合、文字列値は大文字と小文字が区別されます。

MatchType

文字列フィルタのマッチタイプ。

列挙型
MATCH_TYPE_UNSPECIFIED 指定なし
EXACT 文字列値の完全一致。
BEGINS_WITH 文字列値で始まる。
ENDS_WITH 文字列値で終わる。
CONTAINS 文字列値が含まれます。
FULL_REGEXP 正規表現と文字列値の完全一致。
PARTIAL_REGEXP 正規表現と文字列値の部分一致。

アカウント

Google アナリティクス アカウントを表すリソース メッセージ。

フィールド
name

string

出力専用。このアカウントのリソース名。形式: accounts/{account} 例: accounts/100

create_time

Timestamp

出力専用。このアカウントが最初に作成された日時。

update_time

Timestamp

出力専用。アカウント ペイロード フィールドが最後に更新された日時。

display_name

string

必須。このアカウントの表示名(人が読める形式)。

region_code

string

ビジネスの拠点国。Unicode CLDR リージョン コードである必要があります。

deleted

bool

出力専用。このアカウントがソフト削除されているかどうかを示します。削除されたアカウントは、特にリクエストしない限り、リストの結果から除外されます。

gmp_organization

string

出力専用。Google マーケティング プラットフォームの組織リソースの URI。このアカウントが GMP 組織に接続されている場合にのみ設定されます。形式: marketingplatformadmin.googleapis.com/organizations/{org_id}

AccountSummary

アカウントとそのすべての子 Google アナリティクス プロパティの概要を表す仮想リソース。

フィールド
name

string

このアカウントの概要のリソース名。形式: accountSummaries/{account_id} 例: accountSummaries/1000

account

string

このアカウント概要で参照されているアカウントのリソース名。形式: accounts/{account_id} 例: accounts/1000

display_name

string

このアカウント概要で参照されているアカウントの表示名。

property_summaries[]

PropertySummary

このアカウントの子アカウントの概要のリスト。

AcknowledgeUserDataCollectionRequest

AcknowledgeUserDataCollection RPC のリクエスト メッセージ。

フィールド
property

string

必須。ユーザーデータの収集を承認するプロパティ。

acknowledgement

string

必須。このメソッドの呼び出し元がユーザーデータ収集の利用規約を理解していることを示す確認。

このフィールドには、「私は、エンドユーザーのデータの収集と処理に関して、私のサイトやアプリのプロパティから Google アナリティクスが収集したアクセス情報と対象データの関連付けを行うことを含めて、ユーザーから必要なプライバシー情報の開示と承認を受けたことを確認しました」という値を正確に入力する必要があります。

AcknowledgeUserDataCollectionResponse

この型にはフィールドがありません。

AcknowledgeUserDataCollection RPC のレスポンス メッセージ。

ActionType

リソースを変更する可能性があるアクションの種類。

列挙型
ACTION_TYPE_UNSPECIFIED アクション タイプが不明または指定されていません。
CREATED この変更でリソースが作成されました。
UPDATED この変更でリソースが更新されました。
DELETED この変更でリソースが削除されました。

ActorType

Google アナリティクスのリソースを変更できるさまざまな種類のアクタ。

列挙型
ACTOR_TYPE_UNSPECIFIED 不明または未指定のアクターのタイプ。
USER actor_email で指定されたユーザーが行った変更。
SYSTEM Google アナリティクス システムによる変更。
SUPPORT Google アナリティクス サポートチームのスタッフが行った変更。

ApproveDisplayVideo360AdvertiserLinkProposalRequest

ApproveDisplayVideo360AdvertiserLinkProposal RPC のリクエスト メッセージ。

フィールド
name

string

必須。承認する DisplayVideo360AdvertiserLinkProposal の名前。形式の例: properties/1234/displayVideo360AdvertiserLinkProposals/5678

ApproveDisplayVideo360AdvertiserLinkProposalResponse

ApproveDisplayVideo360AdvertiserLinkProposal RPC のレスポンス メッセージ。

フィールド

ArchiveAudienceRequest

ArchiveAudience RPC のリクエスト メッセージ。

フィールド
name

string

必須。形式の例: properties/1234/audiences/5678

ArchiveCustomDimensionRequest

ArchiveCustomDimension RPC のリクエスト メッセージ。

フィールド
name

string

必須。アーカイブするカスタム ディメンションの名前。形式例: properties/1234/customDimensions/5678

ArchiveCustomMetricRequest

ArchiveCustomMetric RPC のリクエスト メッセージ。

フィールド
name

string

必須。アーカイブする CustomMetric の名前。形式の例: properties/1234/customMetrics/5678

AttributionSettings

特定のプロパティに使用されるアトリビューション設定。これはシングルトン リソースです。

フィールド
name

string

出力専用。このアトリビューション設定リソースのリソース名。形式: properties/{property_id}/attributionSettings 例: "properties/1000/attributionSettings"

acquisition_conversion_event_lookback_window

AcquisitionConversionEventLookbackWindow

必須。ユーザー獲得コンバージョン イベントのルックバック ウィンドウの設定。デフォルトの時間は 30 日間です。

other_conversion_event_lookback_window

OtherConversionEventLookbackWindow

必須。ユーザー獲得以外の他のすべてのコンバージョン イベントのルックバック ウィンドウ。デフォルトの時間は 90 日です。

reporting_attribution_model

ReportingAttributionModel

必須。このプロパティのレポートでコンバージョン クレジットの計算に使用されるレポート用のアトリビューション モデル。

このアトリビューション モデルの変更は、履歴データと今後のデータの両方に適用されます。これらの変更は、コンバージョン データと収益データを含むレポートに反映されます。ユーザーデータとセッション データには影響しません。

ads_web_conversion_data_export_scope

AdsWebConversionDataExportScope

必須。リンクされた Google 広告アカウントにエクスポートされるデータのコンバージョン エクスポート範囲。

AcquisitionConversionEventLookbackWindow

アプリの初回インストールまたはサイトの初回アクセスに至るコンバージョン パスに含めるイベントの過去の期間。

列挙型
ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED ルックバック ウィンドウのサイズが指定されていません。
ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_7_DAYS 7 日間のルックバック ウィンドウ。
ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS 30 日間のルックバック ウィンドウ。

AdsWebConversionDataExportScope

リンクされた Google 広告アカウントにエクスポートされるデータのコンバージョン エクスポート範囲。

列挙型
ADS_WEB_CONVERSION_DATA_EXPORT_SCOPE_UNSPECIFIED デフォルト値。この値は使用されません。
NOT_SELECTED_YET データ エクスポート スコープはまだ選択されていません。エクスポート スコープをこの値に戻すことはできません。
PAID_AND_ORGANIC_CHANNELS コンバージョンに対する貢献度は有料チャネルとオーガニック チャネルに割り当てることができますが、Google 広告アカウントに表示されるのは Google 広告のチャネルに割り当てられた貢献度のみです。詳しくは、有料チャネルとオーガニック チャネルをご覧ください。
GOOGLE_PAID_CHANNELS コンバージョンに対する貢献度の割り当てができるのは、Google 広告の有料チャネルのみです。詳しくは、Google の有料チャネルをご覧ください。

OtherConversionEventLookbackWindow

アプリの初回インストールやサイトの初回アクセス以外のすべてのコンバージョンについて、コンバージョン パスに含めるイベントの遡及期間。

列挙型
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED ルックバック ウィンドウのサイズが指定されていません。
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS 30 日間のルックバック ウィンドウ。
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_60_DAYS 60 日間のルックバック ウィンドウ。
OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_90_DAYS 90 日間のルックバック ウィンドウ。

ReportingAttributionModel

このプロパティのレポートでコンバージョン クレジットの計算に使用されるレポート用のアトリビューション モデル。

列挙型
REPORTING_ATTRIBUTION_MODEL_UNSPECIFIED レポート用アトリビューション モデルが指定されていません。
PAID_AND_ORGANIC_CHANNELS_DATA_DRIVEN データドリブン アトリビューションでは、各コンバージョン イベントのデータに基づいてコンバージョンの貢献度を割り当てます。データドリブン モデルは広告主様とコンバージョン イベントごとに異なります。以前の CROSS_CHANNEL_DATA_DRIVEN
PAID_AND_ORGANIC_CHANNELS_LAST_CLICK ノーリファラーを無視し、コンバージョンに至る前にユーザーが最後にクリックしたチャネル(または YouTube のエンゲージ ビュースルー)に、コンバージョン値をすべて割り当てます。以前の CROSS_CHANNEL_LAST_CLICK
GOOGLE_PAID_CHANNELS_LAST_CLICK ユーザーがコンバージョンに至る前に最後にクリックした Google の有料チャネルに、コンバージョン値をすべて割り当てます。以前の ADS_PREFERRED_LAST_CLICK

オーディエンス

オーディエンスを表すリソース メッセージ。

フィールド
name

string

出力専用。このオーディエンス リソースのリソース名。形式: properties/{propertyId}/audiences/{audienceId}

display_name

string

必須。オーディエンスの表示名。

description

string

必須。オーディエンスの説明。

membership_duration_days

int32

必須。変更不可。ユーザーがオーディエンスに留まる期間。540 日を超えて設定することはできません。

ads_personalization_enabled

bool

出力専用。NPA オーディエンスで広告のパーソナライズから除外されている場合、この値は GA によって自動的に false に設定されます。

event_trigger

AudienceEventTrigger

省略可。ユーザーがオーディエンスに参加したときにログに記録するイベントを指定します。設定しない場合、ユーザーがオーディエンスに参加してもイベントはログに記録されません。

exclusion_duration_mode

AudienceExclusionDurationMode

変更不可。除外フィルタに一致するユーザーに対する除外の期間を指定します。これはすべての除外フィルタ句に適用され、オーディエンスに除外フィルタ句がない場合は無視されます。

filter_clauses[]

AudienceFilterClause

必須。変更不可。順序なしリスト。オーディエンスを定義するフィルタ句。すべての句が AND で結合されます。

create_time

Timestamp

出力専用。オーディエンスが作成された日時。

AudienceExclusionDurationMode

除外フィルタに一致するユーザーに対する除外の期間を指定します。

列挙型
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED 指定されていません。
EXCLUDE_TEMPORARILY フィルタ句に一致する期間に、該当するユーザーをオーディエンスから除外します。
EXCLUDE_PERMANENTLY フィルタ句を一度でも満たしたユーザーをオーディエンスから除外します。

AudienceDimensionOrMetricFilter

単一のディメンションまたは指標に対する特定のフィルタ。

フィールド
field_name

string

必須。変更不可。フィルタを適用するディメンション名または指標名。フィールド名がカスタム ディメンションまたはカスタム指標を参照している場合、カスタム ディメンションまたはカスタム指標名の前にスコープ接頭辞が追加されます。スコープ接頭辞やカスタム ディメンション/指標について詳しくは、Google アナリティクス Data API のドキュメントをご覧ください。

at_any_point_in_time

bool

省略可。このフィルタで動的評価が必要かどうかを示します。true に設定すると、一度でも条件を満たしたことがあるユーザーがオーディエンスに追加されます(静的評価)。未設定または false に設定されている場合、オーディエンスのユーザー評価は動的になります。条件を満たしているユーザーがオーディエンスに追加され、条件を満たさなくなったユーザーはオーディエンスから削除されます。

これは、オーディエンスのスコープが ACROSS_ALL_SESSIONS の場合にのみ設定できます。

in_any_n_day_period

int32

省略可。設定した場合は、データを評価する期間を日数で指定します。設定されていない場合、オーディエンス データはライフタイム データ(無限の時間枠など)と比較して評価されます。

たとえば、1 日に設定した場合、当日のデータのみが評価されます。at_any_point_in_time が未設定または false の場合、参照ポイントは現在の日付になります。

設定できるのは、オーディエンスのスコープが ACROSS_ALL_SESSIONS の場合のみで、60 日を超えることはできません。

共用体フィールド one_filter。上記のフィルタのいずれか。one_filter は次のいずれかになります。
string_filter

StringFilter

特定のパターンに一致する文字列タイプのディメンションのフィルタ。

in_list_filter

InListFilter

特定のオプションのリストに一致する文字列ディメンションのフィルタ。

numeric_filter

NumericFilter

ディメンションまたは指標の数値または日付値のフィルタ。

between_filter

BetweenFilter

ディメンションまたは指標の特定の値の間の数値または日付値のフィルタ。

BetweenFilter

ディメンションまたは指標の特定の値の間の数値または日付値のフィルタ。

フィールド
from_value

NumericValue

必須。この番号で始まる(この番号を含む)。

to_value

NumericValue

必須。末尾がこの数値(この数値を含む)

InListFilter

特定のオプションのリストに一致する文字列ディメンションのフィルタ。

フィールド
values[]

string

必須。照合する可能性のある文字列値のリスト。空でない必要があります。

case_sensitive

bool

省略可。true の場合、大文字と小文字が区別されます。false の場合、照合時に大文字と小文字は区別されません。

NumericFilter

ディメンションまたは指標の数値または日付値のフィルタ。

フィールド
operation

Operation

必須。数値フィルタに適用される演算子。

value

NumericValue

必須。照合する数値または日付の値。

オペレーション

数値フィルタに適用される演算子。

列挙型
OPERATION_UNSPECIFIED (指定なし)
EQUAL 等しい。
LESS_THAN 未満。
GREATER_THAN より大きい。

NumericValue

数値を表す。

フィールド
共用体フィールド one_value。数値のいずれか。one_value は次のいずれかになります。
int64_value

int64

整数値。

double_value

double

double 値。

StringFilter

特定のパターンに一致する文字列タイプのディメンションのフィルタ。

フィールド
match_type

MatchType

必須。文字列フィルタのマッチタイプ。

value

string

必須。照合する文字列値。

case_sensitive

bool

省略可。true の場合、大文字と小文字が区別されます。false の場合、照合時に大文字と小文字は区別されません。

MatchType

文字列フィルタのマッチタイプ。

列挙型
MATCH_TYPE_UNSPECIFIED 指定なし
EXACT 文字列値の完全一致。
BEGINS_WITH 文字列値で始まる。
ENDS_WITH 文字列値で終わる。
CONTAINS 文字列値が含まれます。
FULL_REGEXP 正規表現全体が文字列値と一致する。

AudienceEventFilter

単一のイベント名のイベントに一致するフィルタ。イベント パラメータが指定されている場合、このイベント フィルタに一致するのは、単一のイベント名とパラメータ フィルタ式の両方に一致するイベントのサブセットのみです。

フィールド
event_name

string

必須。変更不可。照合するイベントの名前。

event_parameter_filter_expression

AudienceFilterExpression

省略可。指定すると、このフィルタは、単一のイベント名とパラメータ フィルタ式の両方に一致するイベントを照合します。パラメータ フィルタ式内の AudienceEventFilter は設定できません(ネストされたイベント フィルタはサポートされていません)。これは、dimension_or_metric_filter または not_expression の単一の and_group である必要があります。OR の AND はサポートされていません。また、「eventCount」のフィルタが含まれている場合は、そのフィルタのみが考慮され、他のすべてのフィルタは無視されます。

AudienceEventTrigger

ユーザーがオーディエンスに参加したときにログに記録するイベントを指定します。

フィールド
event_name

string

必須。ログに記録されるイベント名。

log_condition

LogCondition

必須。イベントを記録するタイミング。

LogCondition

イベントを記録するタイミングを決定します。

列挙型
LOG_CONDITION_UNSPECIFIED ログ条件が指定されていません。
AUDIENCE_JOINED このイベントは、ユーザーが参加したときにのみログに記録する必要があります。
AUDIENCE_MEMBERSHIP_RENEWED ユーザーがすでにオーディエンスのメンバーである場合でも、オーディエンスの条件が満たされるたびにイベントをログに記録する必要があります。

AudienceFilterClause

単純なフィルタまたはシーケンス フィルタを定義する句。フィルタは、包含型(フィルタ句を満たすユーザーをオーディエンスに含める)または除外型(フィルタ句を満たすユーザーをオーディエンスから除外する)にすることができます。

フィールド
clause_type

AudienceClauseType

必須。これが包含フィルタ句か除外フィルタ句かを指定します。

共用体フィールド filter

filter は次のいずれかになります。

simple_filter

AudienceSimpleFilter

オーディエンスのメンバーになるためにユーザーが満たす必要がある単純なフィルタ。

sequence_filter

AudienceSequenceFilter

ユーザーがオーディエンスのメンバーになるために、特定の順序で発生する必要があるフィルタ。

AudienceClauseType

これが包含フィルタ句か除外フィルタ句かを指定します。

列挙型
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED 指定されていない句のタイプ。
INCLUDE フィルタ句が満たされると、ユーザーはオーディエンスに含まれます。
EXCLUDE フィルタ句が満たされたユーザーは、オーディエンスから除外されます。

AudienceFilterExpression

オーディエンス ディメンション、指標、イベント フィルタの論理式。

フィールド
共用体フィールド expr。フィルタに適用される式。expr は次のいずれかになります。
and_group

AudienceFilterExpressionList

AND 演算で結合する式のリスト。含めることができるのは、or_group を含む AudienceFilterExpressions のみです。これは、最上位の AudienceFilterExpression に設定する必要があります。

or_group

AudienceFilterExpressionList

OR 演算で結合する式のリスト。and_group または or_group を含む AudienceFilterExpression を含めることはできません。

not_expression

AudienceFilterExpression

NOT 演算を適用するフィルタ式(反転、補完など)。含めることができるのは、dimension_or_metric_filter のみです。これは最上位の AudienceFilterExpression では設定できません。

dimension_or_metric_filter

AudienceDimensionOrMetricFilter

単一のディメンションまたは指標に対するフィルタ。これは最上位の AudienceFilterExpression では設定できません。

event_filter

AudienceEventFilter

特定のイベントに一致するフィルタを作成します。これは最上位の AudienceFilterExpression では設定できません。

AudienceFilterExpressionList

オーディエンス フィルタ式のリスト。

フィールド
filter_expressions[]

AudienceFilterExpression

オーディエンス フィルタ式のリスト。

AudienceFilterScope

オーディエンスへの参加についてユーザーを評価する方法を指定する。

列挙型
AUDIENCE_FILTER_SCOPE_UNSPECIFIED スコープが指定されていません。
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT 1 つのイベント内でフィルタ条件が満たされた場合、ユーザーはオーディエンスに追加されます。
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION 1 回のセッション内でフィルタ条件が満たされると、ユーザーはオーディエンスに追加されます。
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS セッション内のいずれかのイベントでフィルタ条件が満たされると、ユーザーはオーディエンスに追加されます。

AudienceSequenceFilter

ユーザーがオーディエンスのメンバーになるために特定の順序で発生する必要があるフィルタを定義します。

フィールド
scope

AudienceFilterScope

必須。変更不可。このフィルタのスコープを指定します。

sequence_maximum_duration

Duration

省略可。シーケンス全体を発生させる制限時間(例: 30 分)を定義します。

sequence_steps[]

AudienceSequenceStep

必須。順序付きのステップのシーケンス。ユーザーがシーケンス フィルタに参加するには、各ステップを完了する必要があります。

AudienceSequenceStep

このユーザーがシーケンスに一致するために、指定された手順の順序で発生する必要がある条件。

フィールド
scope

AudienceFilterScope

必須。変更不可。このステップのスコープを指定します。

immediately_follows

bool

省略可。true の場合、このステップを満たすイベントは、最後のステップを満たすイベントの直後のイベントである必要があります。未設定または false の場合、このステップは前のステップの後に間接的に続くステップです。たとえば、前のステップとこのステップの間にイベントが存在する場合があります。最初のステップでは無視されます。

constraint_duration

Duration

省略可。設定する場合は、このステップが前のステップの constraint_duration 内で満たされる必要があります(例: t[i] - t[i-1] <= constraint_duration)。設定しない場合、期間の要件はありません(期間は実質的に無制限です)。最初のステップでは無視されます。

filter_expression

AudienceFilterExpression

必須。変更不可。各ステップのオーディエンス ディメンション、指標、イベント フィルタの論理式。

AudienceSimpleFilter

オーディエンスのメンバーになるためにユーザーが満たす必要があるシンプルなフィルタを定義します。

フィールド
scope

AudienceFilterScope

必須。変更不可。このフィルタのスコープを指定します。

filter_expression

AudienceFilterExpression

必須。変更不可。オーディエンス ディメンション、指標、イベント フィルタの論理式。

BatchCreateAccessBindingsRequest

BatchCreateAccessBindings RPC のリクエスト メッセージ。

フィールド
parent

string

必須。アクセス バインディングを所有するアカウントまたはプロパティ。CreateAccessBindingRequest メッセージの親フィールドは、空にするか、このフィールドと一致させる必要があります。形式: - accounts/{account} - properties/{property}

requests[]

CreateAccessBindingRequest

必須。作成するアクセス バインディングを指定するリクエスト。バッチで作成できるアクセス バインディングは最大 1,000 個です。

BatchCreateAccessBindingsResponse

BatchCreateAccessBindings RPC のレスポンス メッセージ。

フィールド
access_bindings[]

AccessBinding

作成されたアクセス バインディング。

BatchDeleteAccessBindingsRequest

BatchDeleteAccessBindings RPC のリクエスト メッセージ。

フィールド
parent

string

必須。アクセス バインディングを所有するアカウントまたはプロパティ。DeleteAccessBindingRequest メッセージの「names」フィールドに指定されたすべての値の親は、このフィールドと一致する必要があります。形式: - accounts/{account} - properties/{property}

requests[]

DeleteAccessBindingRequest

必須。削除するアクセス バインディングを指定するリクエスト。バッチで削除できるアクセス バインディングは最大 1,000 個です。

BatchGetAccessBindingsRequest

BatchGetAccessBindings RPC のリクエスト メッセージ。

フィールド
parent

string

必須。アクセス バインディングを所有するアカウントまたはプロパティ。「names」フィールドに指定されたすべての値の親は、このフィールドと一致する必要があります。形式: - accounts/{account} - properties/{property}

names[]

string

必須。取得するアクセス バインディングの名前。バッチで取得できるアクセス バインディングは最大 1,000 個です。形式: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

BatchGetAccessBindingsResponse

BatchGetAccessBindings RPC のレスポンス メッセージ。

フィールド
access_bindings[]

AccessBinding

リクエストされたアクセス バインディング。

BatchUpdateAccessBindingsRequest

BatchUpdateAccessBindings RPC のリクエスト メッセージ。

フィールド
parent

string

必須。アクセス バインディングを所有するアカウントまたはプロパティ。UpdateAccessBindingRequest メッセージで指定されたすべての AccessBinding の親が、このフィールドと一致している必要があります。形式: - accounts/{account} - properties/{property}

requests[]

UpdateAccessBindingRequest

必須。更新するアクセス バインディングを指定するリクエスト。バッチで更新できるアクセス バインディングは最大 1,000 個です。

BatchUpdateAccessBindingsResponse

BatchUpdateAccessBindings RPC のレスポンス メッセージ。

フィールド
access_bindings[]

AccessBinding

アクセス バインディングが更新されました。

CalculatedMetric

計算指標の定義。

フィールド
name

string

出力専用。この CalculatedMetric のリソース名。Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'

description

string

省略可。この計算指標の説明。最大長は 4,096 文字です。

display_name

string

必須。Google アナリティクスの管理画面に表示されるこの計算指標の表示名。最大長は 82 文字です。

calculated_metric_id

string

出力専用。計算指標に使用する ID。UI では、これは「API 名」と呼ばれます。

calculated_metric_id は、外部 API からこの計算指標を参照するときに使用されます。例: calcMetric:{calculated_metric_id}。

metric_unit

MetricUnit

必須。計算された指標の値の型。

restricted_metric_type[]

RestrictedMetricType

出力専用。この指標に含まれる制限付きデータの種類。

formula

string

必須。計算指標の定義。参照される一意のカスタム指標の最大数は 5 です。数式では、+(加算)、-(減算)、-(負)、*(乗算)、/(除算)、()(かっこ)の演算がサポートされています。Long(64 ビット整数)または Double(64 ビット浮動小数点数)に収まる有効な実数であれば、どのような数値でも使用できます。数式の例: "( customEvent:parameter_name + cartPurchaseQuantity ) / 2.0"

invalid_metric_reference

bool

出力専用。true の場合、この計算指標には無効な指標参照があります。invalid_metric_reference が true に設定された計算指標を使用すると、失敗、警告、予期しない結果が生じる可能性があります。

MetricUnit

計算された指標の値を表すことができるタイプ。

列挙型
METRIC_UNIT_UNSPECIFIED MetricUnit が指定されていないか、欠落しています。
STANDARD この指標ではデフォルトの単位が使用されます。
CURRENCY この指標は通貨を測定します。
FEET この指標はフィートで測定されます。
MILES この指標はマイルで測定されます。
METERS この指標はメートル単位で測定されます。
KILOMETERS この指標はキロメートル単位で測定されます。
MILLISECONDS この指標はミリ秒単位で測定されます。
SECONDS この指標は秒単位で測定されます。
MINUTES この指標は分単位で測定されます。
HOURS この指標は時間単位で測定されます。

RestrictedMetricType

費用や収益の指標へのアクセスを制限するユーザーロールと組み合わせて使用される、計算指標内のデータにマークを付けるラベル。

列挙型
RESTRICTED_METRIC_TYPE_UNSPECIFIED タイプが不明または未指定。
COST_DATA 指標は費用データをレポートします。
REVENUE_DATA 指標は収益データをレポートします。

CancelDisplayVideo360AdvertiserLinkProposalRequest

CancelDisplayVideo360AdvertiserLinkProposal RPC のリクエスト メッセージ。

フィールド
name

string

必須。キャンセルする DisplayVideo360AdvertiserLinkProposal の名前。形式の例: properties/1234/displayVideo360AdvertiserLinkProposals/5678

ChangeHistoryChange

単一の Google アナリティクス リソースに対する変更の説明。

フィールド
resource

string

このエントリで変更が記述されているリソースのリソース名。

action

ActionType

このリソースを変更したアクションのタイプ。

resource_before_change

ChangeHistoryResource

変更前のリソースの内容。このリソースがこの変更で作成された場合、このフィールドは存在しません。

resource_after_change

ChangeHistoryResource

変更後のリソースの内容。この変更でこのリソースが削除された場合、このフィールドは存在しません。

ChangeHistoryResource

変更履歴の変更の結果の前後でのリソースのスナップショット。

フィールド

共用体フィールド resource

resource は次のいずれかになります。

account

Account

変更履歴内のアカウント リソースのスナップショット。

property

Property

変更履歴内のプロパティ リソースのスナップショット。

google_signals_settings

GoogleSignalsSettings

変更履歴の GoogleSignalsSettings リソースのスナップショット。

conversion_event

ConversionEvent

変更履歴の ConversionEvent リソースのスナップショット。

measurement_protocol_secret

MeasurementProtocolSecret

変更履歴内の MeasurementProtocolSecret リソースのスナップショット。

custom_dimension

CustomDimension

変更履歴の CustomDimension リソースのスナップショット。

custom_metric

CustomMetric

変更履歴の CustomMetric リソースのスナップショット。

data_retention_settings

DataRetentionSettings

変更履歴内のデータ保持設定リソースのスナップショット。

data_stream

DataStream

変更履歴内の DataStream リソースのスナップショット。

attribution_settings

AttributionSettings

変更履歴の AttributionSettings リソースのスナップショット。

expanded_data_set

ExpandedDataSet

変更履歴内の ExpandedDataSet リソースのスナップショット。

channel_group

ChannelGroup

変更履歴内の ChannelGroup リソースのスナップショット。

enhanced_measurement_settings

EnhancedMeasurementSettings

変更履歴の EnhancedMeasurementSettings リソースのスナップショット。

data_redaction_settings

DataRedactionSettings

変更履歴の DataRedactionSettings リソースのスナップショット。

skadnetwork_conversion_value_schema

SKAdNetworkConversionValueSchema

変更履歴の SKAdNetworkConversionValueSchema リソースのスナップショット。

audience

Audience

変更履歴にあるオーディエンス リソースのスナップショット。

event_create_rule

EventCreateRule

変更履歴内の EventCreateRule リソースのスナップショット。

key_event

KeyEvent

変更履歴内の KeyEvent リソースのスナップショット。

calculated_metric

CalculatedMetric

変更履歴内の CalculatedMetric リソースのスナップショット。

reporting_data_annotation

ReportingDataAnnotation

変更履歴内の ReportingDataAnnotation リソースのスナップショット。

subproperty_sync_config

SubpropertySyncConfig

変更履歴にある SubpropertySyncConfig リソースのスナップショット。

ChangeHistoryEvent

Google アナリティクス アカウントまたはその子プロパティ内で、同じ原因によって行われた一連の変更。一般的な原因としては、Google アナリティクスの管理画面で行われた更新、カスタマー サポートによる変更、Google アナリティクスのシステムによる自動変更などが挙げられます。

フィールド
id

string

この変更履歴イベントの ID。この ID は Google アナリティクス全体で一意です。

change_time

Timestamp

変更が行われた日時。

actor_type

ActorType

この変更を行ったアクターのタイプ。

user_actor_email

string

変更を行った Google アカウントのメールアドレス。アクター フィールドが USER に設定されている場合は有効なメールアドレスになります。それ以外の場合は空になります。削除された Google アカウントはエラーになります。

changes_filtered

bool

true の場合、返された変更リストはフィルタされており、このイベントで発生したすべての変更を表すものではありません。

changes[]

ChangeHistoryChange

SearchChangeHistoryEventsRequest で指定されたフィルタに一致する、この変更履歴イベントで行われた変更のリスト。

ChangeHistoryResourceType

変更履歴から変更が返される可能性があるリソースのタイプ。

列挙型
CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED リソースタイプが不明または指定されていません。
ACCOUNT アカウント リソース
PROPERTY 宿泊施設リソース
GOOGLE_SIGNALS_SETTINGS GoogleSignalsSettings リソース
CONVERSION_EVENT ConversionEvent リソース
MEASUREMENT_PROTOCOL_SECRET MeasurementProtocolSecret リソース
CUSTOM_DIMENSION CustomDimension リソース
CUSTOM_METRIC CustomMetric リソース
DATA_RETENTION_SETTINGS DataRetentionSettings リソース
DATA_STREAM DataStream リソース
ATTRIBUTION_SETTINGS AttributionSettings リソース
EXPANDED_DATA_SET ExpandedDataSet リソース
CHANNEL_GROUP ChannelGroup リソース
ENHANCED_MEASUREMENT_SETTINGS EnhancedMeasurementSettings リソース
DATA_REDACTION_SETTINGS DataRedactionSettings リソース
SKADNETWORK_CONVERSION_VALUE_SCHEMA SKAdNetworkConversionValueSchema リソース
AUDIENCE オーディエンス リソース
EVENT_CREATE_RULE EventCreateRule リソース
KEY_EVENT KeyEvent リソース
CALCULATED_METRIC CalculatedMetric リソース
REPORTING_DATA_ANNOTATION ReportingDataAnnotation リソース
SUBPROPERTY_SYNC_CONFIG SubpropertySyncConfig リソース

ChannelGroup

チャンネル グループを表すリソース メッセージ。

フィールド
name

string

出力専用。このチャネル グループ リソースのリソース名。形式: properties/{property}/channelGroups/{channel_group}

display_name

string

必須。チャンネル グループの表示名。最大文字数は 80 文字です。

description

string

チャネル グループの説明。最大長は 256 文字です。

grouping_rule[]

GroupingRule

必須。チャネルのグループ化ルール。ルールの最大数は 50 です。

system_defined

bool

出力専用。true の場合、このチャネル グループは Google アナリティクスで事前定義されたデフォルトのチャネル グループです。このチャンネル グループの表示名とグループ化ルールは更新できません。

primary

bool

省略可。true の場合、このチャネル グループはレポートのデフォルトのチャネル グループとして使用されます。primary として設定できるチャンネル グループは、一度に 1 つのみです。primary フィールドがチャネル グループに設定されると、以前のメインのチャネル グループで設定が解除されます。

Google アナリティクスの事前定義チャネル グループは、デフォルトでメインのチャネル グループになります。

ChannelGroupFilter

単一ディメンションの特定のフィルタ。

フィールド
field_name

string

必須。変更不可。フィルタするディメンション名。

共用体フィールド value_filter。このフィルタの動作を定義する StringFilter または InListFilter。value_filter は次のいずれかになります。
string_filter

StringFilter

特定のパターンに一致する文字列タイプのディメンションのフィルタ。

in_list_filter

InListFilter

特定のオプションのリストに一致する文字列ディメンションのフィルタ。

InListFilter

特定のオプションのリストに一致する文字列ディメンションのフィルタ。大文字と小文字は区別されません。

フィールド
values[]

string

必須。照合する可能性のある文字列値のリスト。空でない必要があります。

StringFilter

フィールド値が文字列である行をフィルタします。大文字と小文字は区別されません。

フィールド
match_type

MatchType

必須。文字列フィルタのマッチタイプ。

value

string

必須。照合する文字列値。

MatchType

一致を判断するためにフィルタがどのように使用されるか。

列挙型
MATCH_TYPE_UNSPECIFIED デフォルトのマッチタイプ。
EXACT 文字列値の完全一致。
BEGINS_WITH 文字列値で始まる。
ENDS_WITH 文字列値で終わる。
CONTAINS 文字列値が含まれます。
FULL_REGEXP 正規表現が文字列値全体と一致する。
PARTIAL_REGEXP 文字列値と部分的に一致する正規表現。

ChannelGroupFilterExpression

チャネル グループ ディメンション フィルタの論理式。

フィールド
共用体フィールド expr。フィルタに適用される式。expr は次のいずれかになります。
and_group

ChannelGroupFilterExpressionList

AND 演算で結合する式のリスト。or_group を含む ChannelGroupFilterExpressions のみを含めることができます。これは、最上位の ChannelGroupFilterExpression に設定する必要があります。

or_group

ChannelGroupFilterExpressionList

OR 演算で結合する式のリスト。and_group または or_group を含む ChannelGroupFilterExpression を含めることはできません。

not_expression

ChannelGroupFilterExpression

NOT 演算(反転、補完)を適用するフィルタ式。含めることができるのは、dimension_or_metric_filter のみです。これは最上位の ChannelGroupFilterExpression では設定できません。

filter

ChannelGroupFilter

単一ディメンションでのフィルタ。これは最上位の ChannelGroupFilterExpression では設定できません。

ChannelGroupFilterExpressionList

チャネル グループのフィルタ式のリスト。

フィールド
filter_expressions[]

ChannelGroupFilterExpression

チャネル グループのフィルタ式のリスト。

CoarseValue

ConversionValues.event_mappings の条件が満たされたときに、updatePostbackConversionValue SDK 呼び出しで設定される大まかなコンバージョン値。詳細については、SKAdNetwork.CoarseConversionValue をご覧ください。

列挙型
COARSE_VALUE_UNSPECIFIED 大まかな値が指定されていません。
COARSE_VALUE_LOW きめが粗い値: 低。
COARSE_VALUE_MEDIUM メディアの粗い値。
COARSE_VALUE_HIGH きめが粗い値: 高。

ConnectedSiteTag

特定の接続済みのサイトタグの設定。

フィールド
display_name

string

必須。接続されたサイトタグのユーザー指定の表示名。256 文字未満にする必要があります。

tag_id

string

必須。「イベントを転送するタグ ID。測定 ID または「G-ID」とも呼ばれます(例: G-12345)。

ConversionEvent

Google アナリティクス プロパティのコンバージョン イベント。

フィールド
name

string

出力専用。このコンバージョン イベントのリソース名。形式: properties/{property}/conversionEvents/{conversion_event}

event_name

string

変更不可。このコンバージョン イベントのイベント名。例: 「click」、「purchase」

create_time

Timestamp

出力専用。このコンバージョン イベントがプロパティで作成された日時。

deletable

bool

出力専用。設定されている場合、このイベントは現在 DeleteConversionEvent で削除できます。

custom

bool

出力専用。true に設定した場合、このコンバージョン イベントはカスタム イベントを参照します。false に設定した場合、このコンバージョン イベントは GA のデフォルト イベントを参照します。デフォルト イベントは通常、GA で特別な意味を持つイベントです。デフォルト イベントは通常、GA システムによって自動的に作成されますが、プロパティ管理者が作成することもできます。カスタム イベントは、プロパティごとに作成できるカスタム コンバージョン イベントの最大数にカウントされます。

counting_method

ConversionCountingMethod

省略可。セッション内の複数のイベントでコンバージョンをカウントする方法。この値を指定しない場合、ONCE_PER_EVENT に設定されます。

default_conversion_value

DefaultConversionValue

省略可。コンバージョン イベントのデフォルト値と通貨を定義します。

ConversionCountingMethod

セッション内の複数のイベントでコンバージョンをカウントする方法。

列挙型
CONVERSION_COUNTING_METHOD_UNSPECIFIED カウント方法が指定されていません。
ONCE_PER_EVENT 各イベント インスタンスはコンバージョンと見なされます。
ONCE_PER_SESSION イベント インスタンスは、ユーザーごとにセッションごとに最大 1 回コンバージョンと見なされます。

DefaultConversionValue

コンバージョン イベントのデフォルト値と通貨を定義します。値と通貨の両方を指定する必要があります。

フィールド
value

double

この値は、イベントの「value」パラメータが設定されていない、指定された event_name のすべてのコンバージョンの値に使用されます。

currency_code

string

この event_name のコンバージョン イベントに通貨が設定されていない場合、この通貨がデフォルトとして適用されます。ISO 4217 通貨コードの形式で指定する必要があります。詳細については、https://en.wikipedia.org/wiki/ISO_4217 をご覧ください。

ConversionValues

SKAdNetwork コンバージョン値スキーマのポストバック ウィンドウのコンバージョン値の設定。

フィールド
display_name

string

SKAdNetwork コンバージョン値の表示名。表示名の最大長は 50 UTF-16 コード単位です。

coarse_value

CoarseValue

必須。きめの粗いコンバージョン値。

この値が固有であることは保証されていません。

event_mappings[]

EventMapping

このコンバージョン値を達成するために満たす必要があるイベント条件。このリスト内の条件は AND で連結されます。ポストバック ウィンドウが有効になっている場合は、エントリが 1 ~ 3 個必要です。

lock_enabled

bool

true の場合、SDK は現在のポストバック ウィンドウでこのコンバージョン値にロックされます。

fine_value

int32

粒度が細かいコンバージョン値。これは最初のポストバック ウィンドウにのみ適用されます。有効な値は [0,63] です。ポストバック ウィンドウ 1 には設定する必要がありますが、ポストバック ウィンドウ 2 と 3 には設定しないでください。この値が固有であることは保証されていません。

最初のポストバック ウィンドウの設定が 2 つ目または 3 つ目のポストバック ウィンドウで再利用される場合、このフィールドは影響しません。

CreateAccessBindingRequest

CreateAccessBinding RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式: - accounts/{account} - properties/{property}

access_binding

AccessBinding

必須。作成するアクセス バインディング。

CreateAdSenseLinkRequest

CreateAdSenseLink メソッドに渡されるリクエスト メッセージ。

フィールド
parent

string

必須。AdSense リンクを作成するプロパティ。形式: properties/{propertyId} 例: properties/1234

CreateAudienceRequest

CreateAudience RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/1234

audience

Audience

必須。作成するオーディエンス。

CreateBigQueryLinkRequest

CreateBigQueryLink RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/1234

CreateCalculatedMetricRequest

CreateCalculatedMetric RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式: properties/{property_id} 例: properties/1234

calculated_metric_id

string

必須。計算指標に使用する ID。計算指標のリソース名の最終的なコンポーネントになります。

この値は 1 ~ 80 文字で、有効な文字は /[a-zA-Z0-9_]/ です。スペースは使用できません。calculated_metric_id は、プロパティ内のすべての計算指標で一意である必要があります。calculated_metric_id は、外部 API からこの計算指標を参照する場合に使用されます(例: calcMetric:{calculated_metric_id})。

calculated_metric

CalculatedMetric

必須。作成する CalculatedMetric。

CreateChannelGroupRequest

CreateChannelGroup RPC のリクエスト メッセージ。

フィールド
parent

string

必須。ChannelGroup を作成するプロパティ。形式の例: properties/1234

channel_group

ChannelGroup

必須。作成する ChannelGroup。

CreateConnectedSiteTagRequest

CreateConnectedSiteTag RPC のリクエスト メッセージ。

フィールド
property

string

接続済みのサイトタグを作成するユニバーサル アナリティクス プロパティ。この API は GA4 プロパティをサポートしていません。形式: properties/{universalAnalyticsPropertyId} 例: properties/1234

connected_site_tag

ConnectedSiteTag

必須。ユニバーサル アナリティクス プロパティに追加するタグ

CreateConnectedSiteTagResponse

この型にはフィールドがありません。

CreateConnectedSiteTag RPC のレスポンス メッセージ。

CreateConversionEventRequest

CreateConversionEvent RPC のリクエスト メッセージ

フィールド
conversion_event

ConversionEvent

必須。作成するコンバージョン イベント。

parent

string

必須。このコンバージョン イベントが作成される親プロパティのリソース名。形式: properties/123

CreateCustomDimensionRequest

CreateCustomDimension RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/1234

custom_dimension

CustomDimension

必須。作成するカスタム ディメンション。

CreateCustomMetricRequest

CreateCustomMetric RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/1234

custom_metric

CustomMetric

必須。作成する CustomMetric。

CreateDataStreamRequest

CreateDataStream RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/1234

data_stream

DataStream

必須。作成する DataStream。

CreateDisplayVideo360AdvertiserLinkProposalRequest

CreateDisplayVideo360AdvertiserLinkProposal RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/1234

CreateDisplayVideo360AdvertiserLinkRequest

CreateDisplayVideo360AdvertiserLink RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/1234

CreateEventCreateRuleRequest

CreateEventCreateRule RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/123/dataStreams/456

event_create_rule

EventCreateRule

必須。作成する EventCreateRule。

CreateEventEditRuleRequest

CreateEventEditRule RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/123/dataStreams/456

event_edit_rule

EventEditRule

必須。作成する EventEditRule。

CreateExpandedDataSetRequest

CreateExpandedDataSet RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/1234

expanded_data_set

ExpandedDataSet

必須。作成する ExpandedDataSet。

CreateFirebaseLinkRequest

CreateFirebaseLink RPC のリクエスト メッセージ

フィールド
parent

string

必須。形式: properties/{property_id}

例: properties/1234

CreateGoogleAdsLinkRequest

CreateGoogleAdsLink RPC のリクエスト メッセージ

フィールド
parent

string

必須。形式の例: properties/1234

CreateKeyEventRequest

CreateKeyEvent RPC のリクエスト メッセージ

フィールド
key_event

KeyEvent

必須。作成するキーイベント。

parent

string

必須。このキーイベントが作成される親プロパティのリソース名。形式: properties/123

CreateMeasurementProtocolSecretRequest

CreateMeasurementProtocolSecret RPC のリクエスト メッセージ

フィールド
parent

string

必須。このシークレットが作成される親リソース。形式: properties/{property}/dataStreams/{dataStream}

measurement_protocol_secret

MeasurementProtocolSecret

必須。作成する Measurement Protocol Secret。

CreatePropertyRequest

CreateProperty RPC のリクエスト メッセージ。

フィールド
property

Property

必須。作成するプロパティ。注: 指定するプロパティには親を指定する必要があります。

CreateReportingDataAnnotationRequest

CreateReportingDataAnnotation RPC のリクエスト メッセージ。

フィールド
parent

string

必須。レポートデータ アノテーションを作成するプロパティ。形式: properties/property_id 例: properties/123

reporting_data_annotation

ReportingDataAnnotation

必須。作成するレポートデータ アノテーション。

CreateRollupPropertyRequest

CreateRollupProperty RPC のリクエスト メッセージ。

フィールド
rollup_property

Property

必須。作成する統合プロパティ。

source_properties[]

string

省略可。作成される統合プロパティの参照元となるプロパティのリソース名。

CreateRollupPropertyResponse

CreateRollupProperty RPC のレスポンス メッセージ。

フィールド
rollup_property

Property

作成された統合プロパティ。

CreateRollupPropertySourceLinkRequest

CreateRollupPropertySourceLink RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式: properties/{property_id} 例: properties/1234

CreateSKAdNetworkConversionValueSchemaRequest

CreateSKAdNetworkConversionValueSchema RPC のリクエスト メッセージ。

フィールド
parent

string

必須。このスキーマが作成される親リソース。形式: properties/{property}/dataStreams/{dataStream}

skadnetwork_conversion_value_schema

SKAdNetworkConversionValueSchema

必須。作成する SKAdNetwork コンバージョン値スキーマ。

CreateSearchAds360LinkRequest

CreateSearchAds360Link RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/1234

CreateSubpropertyEventFilterRequest

CreateSubpropertyEventFilter RPC のリクエスト メッセージ。

フィールド
parent

string

必須。サブプロパティ イベント フィルタを作成する通常のプロパティ。形式: properties/property_id 例: properties/123

subproperty_event_filter

SubpropertyEventFilter

必須。作成するサブプロパティ イベント フィルタ。

CustomDimension

カスタム ディメンションの定義。

フィールド
name

string

出力専用。このカスタム ディメンション リソースのリソース名。形式: properties/{property}/customDimensions/{customDimension}

parameter_name

string

必須。変更不可。このカスタム ディメンションのタグ設定パラメータ名。

ユーザー スコープのディメンションの場合は、ユーザー プロパティ名です。イベント スコープのディメンションの場合は、イベント パラメータ名です。

アイテム スコープのディメンションの場合は、e コマース アイテム配列に含まれるパラメータ名です。

使用できるのは英数字とアンダースコアのみです。先頭は英字にする必要があります。ユーザー スコープのディメンションの最大長は 24 文字、イベント スコープのディメンションの最大長は 40 文字です。

display_name

string

必須。アナリティクスの管理画面に表示されるこのカスタム ディメンションの表示名。最大長は 82 文字で、英数字、スペース、アンダースコアを使用できます。先頭は英字にする必要があります。以前のシステム生成の表示名には角かっこが含まれている場合がありますが、このフィールドを更新しても角かっこは使用できなくなります。

description

string

省略可。このカスタム ディメンションの説明。最大文字数は 150 文字です。

scope

DimensionScope

必須。変更不可。このディメンションのスコープ。

disallow_ads_personalization

bool

省略可。true に設定すると、このディメンションは非パーソナライズド広告として設定され、広告のパーソナライズから除外されます。

現在のところ、この機能はユーザー スコープのカスタム ディメンションでのみサポートされています。

DimensionScope

このディメンションのスコープで有効な値。

列挙型
DIMENSION_SCOPE_UNSPECIFIED スコープが不明または未指定。
EVENT イベント スコープのディメンション。
USER ユーザー スコープのディメンション。
ITEM e コマース商品にスコープ設定されたディメンション

CustomMetric

カスタム指標の定義。

フィールド
name

string

出力専用。この CustomMetric リソースのリソース名。形式: properties/{property}/customMetrics/{customMetric}

parameter_name

string

必須。変更不可。このカスタム指標のタグ付け名。

イベント スコープの指標の場合は、イベント パラメータ名です。

使用できるのは英数字とアンダースコアのみです。先頭は英字にする必要があります。イベント スコープの指標の最大長は 40 文字です。

display_name

string

必須。アナリティクスの UI に表示されるこのカスタム指標の表示名。最大長は 82 文字で、英数字、スペース、アンダースコアを使用できます。先頭は英字にする必要があります。以前のシステム生成の表示名には角かっこが含まれている場合がありますが、このフィールドを更新しても角かっこは使用できなくなります。

description

string

省略可。このカスタム ディメンションの説明。最大文字数は 150 文字です。

measurement_unit

MeasurementUnit

必須。カスタム指標の値の型。

scope

MetricScope

必須。変更不可。このカスタム指標のスコープ。

restricted_metric_type[]

RestrictedMetricType

省略可。この指標に含まれる可能性がある制限付きデータの種類。測定単位が「CURRENCY」の指標に必須です。測定単位が通貨以外の指標の場合は空にする必要があります。

MeasurementUnit

カスタム指標の値を表すことができる型。

通貨の表示は今後変更される可能性があり、API の互換性を破る変更が必要になる場合があります。

列挙型
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit が指定されていないか、指定されていません。
STANDARD この指標ではデフォルトの単位が使用されます。
CURRENCY この指標は通貨を測定します。
FEET この指標はフィートで測定されます。
METERS この指標はメートル単位で測定されます。
KILOMETERS この指標はキロメートル単位で測定されます。
MILES この指標はマイルで測定されます。
MILLISECONDS この指標はミリ秒単位で測定されます。
SECONDS この指標は秒単位で測定されます。
MINUTES この指標は分単位で測定されます。
HOURS この指標は時間単位で測定されます。

MetricScope

この指標のスコープ。

列挙型
METRIC_SCOPE_UNSPECIFIED スコープが不明または未指定。
EVENT イベント スコープの指標。

RestrictedMetricType

このカスタム指標のデータを、特定のユーザーに制限する必要があるデータとしてマークするラベル。

列挙型
RESTRICTED_METRIC_TYPE_UNSPECIFIED タイプが不明または未指定。
COST_DATA 指標は費用データをレポートします。
REVENUE_DATA 指標は収益データをレポートします。

DataRedactionSettings

クライアントサイドのデータ除去の設定。ウェブ ストリームのシングルトン リソース。

フィールド
name

string

出力専用。このデータ除去設定リソースの名前。形式: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings 例: "properties/1000/dataStreams/2000/dataRedactionSettings"

email_redaction_enabled

bool

有効にすると、メールアドレスに類似するイベント パラメータまたはユーザー プロパティの値はすべて秘匿化されます。

query_parameter_redaction_enabled

bool

クエリ パラメータの除去では、クエリ パラメータが設定されたクエリ パラメータのセット内にある場合、クエリ パラメータのキーと値の部分が削除されます。

有効にすると、ストリームに対して URL クエリ置換ロジックが実行されます。query_parameter_keys で定義されたクエリ パラメータはすべて除去されます。

query_parameter_keys[]

string

URL に存在する場合に、除去ロジックを適用するクエリ パラメータ キー。クエリ パラメータの照合では、大文字と小文字は区別されません。

query_parameter_replacement_enabled が true の場合、少なくとも 1 つの要素を含める必要があります。キーにカンマを含めることはできません。

DataRetentionSettings

データ保持の設定値。これはシングルトン リソースです。

フィールド
name

string

出力専用。この DataRetentionSetting リソースのリソース名。形式: properties/{property}/dataRetentionSettings

event_data_retention

RetentionDuration

必須。イベントレベルのデータが保持される期間。

user_data_retention

RetentionDuration

必須。ユーザー単位のデータが保持される期間。

reset_user_data_on_new_activity

bool

true の場合、そのユーザーからのすべてのイベントでユーザー識別子の保持期間がリセットされます。

RetentionDuration

データ保持期間の有効な値。

列挙型
RETENTION_DURATION_UNSPECIFIED データの保持期間が指定されていません。
TWO_MONTHS データの保持期間は 2 か月です。
FOURTEEN_MONTHS データの保持期間は 14 か月です。
TWENTY_SIX_MONTHS データの保持期間は 26 か月です。360 プロパティでのみ使用できます。イベントデータでのみ使用できます。
THIRTY_EIGHT_MONTHS データ保持期間は 38 か月です。360 プロパティでのみ使用できます。イベントデータでのみ使用できます。
FIFTY_MONTHS データの保持期間は 50 か月です。360 プロパティでのみ使用できます。イベントデータでのみ使用できます。

DataSharingSettings

Google アナリティクス アカウントのデータ共有設定を表すリソース メッセージ。

フィールド
name

string

出力専用。リソース名。形式: accounts/{account}/dataSharingSettings 例: "accounts/1000/dataSharingSettings"

sharing_with_google_support_enabled

bool

サービスの提供や技術的な問題の解決に必要と判断された場合に、Google のテクニカル サポート担当者がお客様の Google アナリティクス データやアカウントにアクセスすることを許可します。

このフィールドは、Google アナリティクスの管理画面の [テクニカル サポート] フィールドにマッピングされます。

sharing_with_google_assigned_sales_enabled

bool

Google がお客様の Google アナリティクス アカウントのデータ(アカウントの使用状況や設定に関するデータ、Google サービスの費用、Google アナリティクス アカウントに関連付けられているユーザーなど)にアクセスできるようにします。これにより、Google は Google アナリティクスやその他のビジネス向け Google サービス全体で分析情報、提案、最適化案、最適化のヒントなどを提供し、Google のサービスを最大限に活用できるようにサポートすることができます。

このフィールドは、Google アナリティクスの管理画面の [ビジネス向けのおすすめ設定] フィールドにマッピングされます。

sharing_with_google_any_sales_enabled
(deprecated)

bool

非推奨です。このフィールドは使用されなくなり、常に false を返します。

sharing_with_google_products_enabled

bool

Google が他の Google プロダクトやサービスの改善のためにデータを使用することを許可します。

このフィールドは、Google アナリティクスの管理画面の [Google のプロダクトとサービス] フィールドにマッピングされます。

sharing_with_others_enabled

bool

集計された測定データを共有すると、予測、モデル化されたデータ、ベンチマークなどに利用され、ビジネスに関するより豊富な分析情報の提供に役立てられます。お客様が共有するデータ(共有元のプロパティの情報を含む)は、ビジネス分析情報の生成に使用される前に集計され、匿名となります。

このフィールドは、Google アナリティクスの管理画面の [モデリングのためのデータ提供とビジネス分析情報] フィールドにマッピングされます。

DataStream

データ ストリームを表すリソース メッセージ。

フィールド
name

string

出力専用。このデータ ストリームのリソース名。形式: properties/{property_id}/dataStreams/{stream_id} 例: "properties/1000/dataStreams/2000"

type

DataStreamType

必須。変更不可。この DataStream リソースのタイプ。

display_name

string

データ ストリームの表示名(人が読める形式)。

ウェブデータ ストリームに必須です。

表示名の最大長は 255 UTF-16 コード単位です。

create_time

Timestamp

出力専用。このストリームが最初に作成された時刻。

update_time

Timestamp

出力専用。ストリーム ペイロード フィールドが最後に更新された時刻。

共用体フィールド stream_data。特定のデータ ストリーム タイプのデータ。設定されるメッセージは、このストリームのタイプに対応しています。stream_data は次のいずれかになります。
web_stream_data

WebStreamData

ウェブ ストリームに固有のデータ。タイプが WEB_DATA_STREAM の場合は入力する必要があります。

android_app_stream_data

AndroidAppStreamData

Android アプリ ストリームに固有のデータ。タイプが ANDROID_APP_DATA_STREAM の場合は入力する必要があります。

ios_app_stream_data

IosAppStreamData

iOS アプリ ストリームに固有のデータ。タイプが IOS_APP_DATA_STREAM の場合は入力する必要があります。

AndroidAppStreamData

Android アプリ ストリームに固有のデータ。

フィールド
firebase_app_id

string

出力専用。Firebase 内の対応する Android アプリの ID(存在する場合)。この ID は、Android アプリを削除して再作成すると変更される場合があります。

package_name

string

変更不可。測定対象のアプリのパッケージ名。例: "com.example.myandroidapp"

DataStreamType

データ ストリームのタイプ。

列挙型
DATA_STREAM_TYPE_UNSPECIFIED タイプが不明または指定されていません。
WEB_DATA_STREAM ウェブデータ ストリーム。
ANDROID_APP_DATA_STREAM Android アプリデータ ストリーム。
IOS_APP_DATA_STREAM iOS アプリデータ ストリーム。

IosAppStreamData

iOS アプリ ストリームに固有のデータ。

フィールド
firebase_app_id

string

出力専用。Firebase 内の対応する iOS アプリの ID(存在する場合)。この ID は、iOS アプリを削除して再作成すると変更される可能性があります。

bundle_id

string

必須。変更不可。アプリの Apple App Store バンドル ID(例:「com.example.myiosapp」)

WebStreamData

ウェブ ストリームに固有のデータ。

フィールド
measurement_id

string

出力専用。アナリティクスの測定 ID。

例: 「G-1A2BCD345E」

firebase_app_id

string

出力専用。Firebase 内の対応するウェブアプリの ID(存在する場合)。この ID は、ウェブアプリを削除して再作成すると変更される可能性があります。

default_uri

string

測定対象のウェブアプリのドメイン名(空白可)。例: 「http://www.google.com」、「https://www.google.com」

DeleteAccessBindingRequest

DeleteAccessBinding RPC のリクエスト メッセージ。

フィールド
name

string

必須。形式: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

DeleteAccountRequest

DeleteAccount RPC のリクエスト メッセージ。

フィールド
name

string

必須。ソフト削除するアカウントの名前。形式: accounts/{account} 例: accounts/100

DeleteAdSenseLinkRequest

DeleteAdSenseLink メソッドに渡されるリクエスト メッセージ。

フィールド
name

string

必須。削除する AdSense リンクの一意の識別子。形式: properties/{propertyId}/adSenseLinks/{linkId} 例: properties/1234/adSenseLinks/5678

DeleteBigQueryLinkRequest

DeleteBigQueryLink RPC のリクエスト メッセージ。

フィールド
name

string

必須。削除する BigQueryLink。形式の例: properties/1234/bigQueryLinks/5678

DeleteCalculatedMetricRequest

DeleteCalculatedMetric RPC のリクエスト メッセージ。

フィールド
name

string

必須。削除する CalculatedMetric の名前。形式: properties/{property_id}/calculatedMetrics/{calculated_metric_id} 例: properties/1234/calculatedMetrics/Metric01

DeleteChannelGroupRequest

DeleteChannelGroup RPC のリクエスト メッセージ。

フィールド
name

string

必須。削除する ChannelGroup。形式の例: properties/1234/channelGroups/5678

DeleteConnectedSiteTagRequest

DeleteConnectedSiteTag RPC のリクエスト メッセージ。

フィールド
property

string

接続済みのサイトタグを削除するユニバーサル アナリティクス プロパティ。この API は GA4 プロパティをサポートしていません。形式: properties/{universalAnalyticsPropertyId} 例: properties/1234

tag_id

string

イベントを転送するタグ ID。測定 ID または「G-ID」とも呼ばれます(例: G-12345)。

DeleteConversionEventRequest

DeleteConversionEvent RPC のリクエスト メッセージ

フィールド
name

string

必須。削除するコンバージョン イベントのリソース名。形式: properties/{property}/conversionEvents/{conversion_event} 例: "properties/123/conversionEvents/456"

DeleteDataStreamRequest

DeleteDataStream RPC のリクエスト メッセージ。

フィールド
name

string

必須。削除する DataStream の名前。形式の例: properties/1234/dataStreams/5678

DeleteDisplayVideo360AdvertiserLinkProposalRequest

DeleteDisplayVideo360AdvertiserLinkProposal RPC のリクエスト メッセージ。

フィールド
name

string

必須。削除する DisplayVideo360AdvertiserLinkProposal の名前。形式の例: properties/1234/displayVideo360AdvertiserLinkProposals/5678

DeleteDisplayVideo360AdvertiserLinkRequest

DeleteDisplayVideo360AdvertiserLink RPC のリクエスト メッセージ。

フィールド
name

string

必須。削除する DisplayVideo360AdvertiserLink の名前。形式の例: properties/1234/displayVideo360AdvertiserLinks/5678

DeleteEventCreateRuleRequest

DeleteEventCreateRule RPC のリクエスト メッセージ。

フィールド
name

string

必須。形式の例: properties/123/dataStreams/456/eventCreateRules/789

DeleteEventEditRuleRequest

DeleteEventEditRule RPC のリクエスト メッセージ。

フィールド
name

string

必須。形式の例: properties/123/dataStreams/456/eventEditRules/789

DeleteExpandedDataSetRequest

DeleteExpandedDataSet RPC のリクエスト メッセージ。

フィールド
name

string

必須。形式の例: properties/1234/expandedDataSets/5678

DeleteFirebaseLinkRequest

DeleteFirebaseLink RPC のリクエスト メッセージ

フィールド
name

string

必須。形式: properties/{property_id}/firebaseLinks/{firebase_link_id}

例: properties/1234/firebaseLinks/5678

DeleteGoogleAdsLinkRequest

DeleteGoogleAdsLink RPC のリクエスト メッセージ。

フィールド
name

string

必須。形式の例: properties/1234/googleAdsLinks/5678

DeleteKeyEventRequest

DeleteKeyEvent RPC のリクエスト メッセージ

フィールド
name

string

必須。削除するキーイベントのリソース名。形式: properties/{property}/keyEvents/{key_event} 例: "properties/123/keyEvents/456"

DeleteMeasurementProtocolSecretRequest

DeleteMeasurementProtocolSecret RPC のリクエスト メッセージ

フィールド
name

string

必須。削除する MeasurementProtocolSecret の名前。形式: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

DeletePropertyRequest

DeleteProperty RPC のリクエスト メッセージ。

フィールド
name

string

必須。ソフト削除するプロパティの名前。形式: properties/{property_id} 例: "properties/1000"

DeleteReportingDataAnnotationRequest

DeleteReportingDataAnnotation RPC のリクエスト メッセージ。

フィールド
name

string

必須。削除する Reporting Data Annotation のリソース名。形式: properties/property_id/reportingDataAnnotations/reporting_data_annotation 例: properties/123/reportingDataAnnotations/456

DeleteRollupPropertySourceLinkRequest

DeleteRollupPropertySourceLink RPC のリクエスト メッセージ。

フィールド
name

string

必須。形式: properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} 例: properties/1234/rollupPropertySourceLinks/5678

DeleteSKAdNetworkConversionValueSchemaRequest

DeleteSKAdNetworkConversionValueSchema RPC のリクエスト メッセージ。

フィールド
name

string

必須。削除する SKAdNetworkConversionValueSchema の名前。Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}

DeleteSearchAds360LinkRequest

DeleteSearchAds360Link RPC のリクエスト メッセージ。

フィールド
name

string

必須。削除する SearchAds360Link の名前。形式例: properties/1234/SearchAds360Links/5678

DeleteSubpropertyEventFilterRequest

DeleteSubpropertyEventFilter RPC のリクエスト メッセージ。

フィールド
name

string

必須。削除するサブプロパティ イベント フィルタのリソース名。形式: properties/property_id/subpropertyEventFilters/subproperty_event_filter 例: properties/123/subpropertyEventFilters/456

DisplayVideo360AdvertiserLinkProposal

Google アナリティクスのプロパティとディスプレイ&ビデオ 360 の広告主をリンクするための提案。

プロポーザルは、承認されると DisplayVideo360AdvertiserLink に変換されます。インバウンド プロポーザルは Google アナリティクスの管理者が承認し、アウトバウンド プロポーザルはディスプレイ&ビデオ 360 の管理者が承認します。

フィールド
name

string

出力専用。この DisplayVideo360AdvertiserLinkProposal リソースのリソース名。形式: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId}

注: proposalId はディスプレイ&ビデオ 360 の広告主 ID ではありません。

advertiser_id

string

変更不可。ディスプレイ&ビデオ 360 広告主の広告主 ID。

advertiser_display_name

string

出力専用。ディスプレイ&ビデオ 360 広告主の表示名。ディスプレイ&ビデオ 360 から送信された提案書にのみ入力されます。

validation_email

string

入力のみのディスプレイ&ビデオ 360 に送信する提案では、このフィールドに、対象の広告主の管理者のメールアドレスを設定する必要があります。これは、Google アナリティクスの管理者が、ディスプレイ&ビデオ 360 の広告主の管理者を少なくとも 1 人把握していることを確認するために使用されます。提案の承認は 1 人のユーザーに限定されません。提案を承認できるのは、ディスプレイ&ビデオ 360 の広告主の管理者です。

ads_personalization_enabled

BoolValue

変更不可。この統合でカスタマイズされた広告向けの機能を有効にします。このフィールドが作成時に設定されていない場合、デフォルトで true になります。

campaign_data_sharing_enabled

BoolValue

変更不可。ディスプレイ&ビデオ 360 からキャンペーン データをインポートできます。このフィールドが作成時に設定されていない場合、デフォルトで true になります。

cost_data_sharing_enabled

BoolValue

変更不可。ディスプレイ&ビデオ 360 から費用データをインポートできるようにします。これは、campaign_data_sharing_enabled が有効になっている場合にのみ有効にできます。このフィールドが作成時に設定されていない場合、デフォルトで true になります。

EnhancedMeasurementSettings

ウェブ DataStream のシングルトン リソース。追加のサイト インタラクションとコンテンツの測定を構成します。

フィールド
name

string

出力専用。拡張計測機能の設定のリソース名。形式: properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings 例: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"

stream_enabled

bool

測定機能の強化の設定を使用して、このウェブ ストリームのインタラクションとコンテンツを自動的に測定するかどうかを示します。

この値を変更しても設定自体には影響しませんが、設定が適用されるかどうかを決定します。

scrolls_enabled

bool

有効にすると、ユーザーがページの一番下までスクロールするたびに、スクロール イベントを記録します。

outbound_clicks_enabled

bool

有効にすると、ユーザーがドメインから移動するリンクをクリックするたびに、離脱クリック イベントを記録します。

site_search_enabled

bool

有効にすると、ユーザーがサイト上で検索を行うたびに、(クエリ パラメータに基づいて)検索結果の表示イベントを記録します。

video_engagement_enabled

bool

有効にすると、ユーザーがサイトに埋め込まれた動画を視聴すると、動画再生イベント、動画進捗イベント、動画完全再生イベントを記録します。

file_downloads_enabled

bool

有効にすると、一般的なドキュメント、圧縮ファイル、アプリケーション、動画、音声拡張子をダウンロードするリンクがクリックされるたびに、ファイル ダウンロード イベントを記録します。

page_changes_enabled

bool

有効にすると、ウェブサイトでブラウザの履歴ステータスが変更されるたびに、ページビュー イベントを記録します。

form_interactions_enabled

bool

有効にすると、ユーザーがウェブサイト上のフォームを操作するたびに、フォーム操作イベントを記録します。デフォルトは false です。

search_query_parameter

string

必須。サイト内検索パラメータとして解釈する URL クエリ パラメータ。最大長は 1,024 文字です。空白にすることはできません。

uri_query_parameter

string

追加の URL クエリ パラメータ。最大長は 1,024 文字です。

EventCreateRule

イベント作成ルールでは、参照元イベントの一致条件に基づいて、まったく新しいイベントの作成をトリガーする条件を定義します。ソースイベントのパラメータの追加ミューテーションを定義できます。

イベントの編集ルールとは異なり、イベント作成ルールには定義された順序はありません。これらはすべて独立して実行されます。

イベントの編集ルールとイベントの作成ルールを使用して、イベントの作成ルールから作成されたイベントを変更することはできません。

フィールド
name

string

出力専用。この EventCreateRule リソースのリソース名。形式: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}

destination_event

string

必須。作成する新しいイベントの名前。

この値は、* 40 文字未満 * 文字、数字、_(アンダースコア)のみで構成 * 先頭が文字である必要があります。

event_conditions[]

MatchingCondition

必須。少なくとも 1 つの条件が必要です。最大 10 個の条件を設定できます。このルールを適用するには、ソースイベントの条件が一致している必要があります。

source_copy_parameters

bool

true の場合、ソース パラメータが新しいイベントにコピーされます。false または未設定の場合、内部以外のパラメータはすべてソースイベントからコピーされません。パラメータの変更は、パラメータがコピーされた後に適用されます。

parameter_mutations[]

ParameterMutation

パラメータ ミューテーションは、新しいイベントのパラメータ動作を定義し、順番に適用されます。適用できるミューテーションは 20 個までです。

EventEditRule

イベント編集ルールでは、ソースイベントの一致条件に基づいて完全に新しいイベントの作成をトリガーする条件を定義します。ソースイベントのパラメータの追加ミューテーションを定義できます。

イベント作成ルールとは異なり、イベント編集ルールは定義された順序で適用されます。

イベントの作成ルールから作成されたイベントを変更するために、イベントの編集ルールを使用できません。

フィールド
name

string

ID。この EventEditRule リソースのリソース名。形式: properties/{property}/dataStreams/{data_stream}/eventEditRules/{event_edit_rule}

display_name

string

必須。このイベント編集ルールの表示名。最大 255 文字まで入力できます。

event_conditions[]

MatchingCondition

必須。このルールを適用するには、ソースイベントの条件が一致している必要があります。少なくとも 1 つの条件が必要です。最大 10 個まで設定できます。

parameter_mutations[]

ParameterMutation

必須。パラメータ ミューテーションは、新しいイベントのパラメータ動作を定義し、順番に適用されます。適用できるミューテーションは 20 個までです。

processing_order

int64

出力専用。このルールが適用される注文。この値より小さい注文値のルールは、このルールの前に処理され、この値より大きい注文値のルールは、このルールの後に処理されます。新しいイベント編集ルールには、注文の最後に注文値が割り当てられます。

この値は、イベント作成ルールには適用されません。

EventMapping

イベントに一致するイベント設定条件。

フィールド
event_name

string

必須。Google アナリティクス イベントの名前。常に設定する必要があります。表示名の最大長は 40 UTF-16 コード単位です。

min_event_count

int64

次の 4 つの最小値または最大値のいずれかを設定する必要があります。設定した値は AND 演算で結合され、イベントを適格にします。イベントが発生した最小回数。設定しない場合、最小イベント数はチェックされません。

max_event_count

int64

イベントが発生した最大回数。設定しない場合、最大イベント数はチェックされません。

min_event_value

double

イベントによって発生した最小収益。収益の通貨は宿泊施設レベルで定義されます。設定しない場合、最小イベント値はチェックされません。

max_event_value

double

イベントによって発生した最大収益。収益の通貨は宿泊施設レベルで定義されます。設定しない場合、最大イベント値はチェックされません。

ExpandedDataSet

ExpandedDataSet を表すリソース メッセージ。

フィールド
name

string

出力専用。この ExpandedDataSet リソースのリソース名。形式: properties/{property_id}/expandedDataSets/{expanded_data_set}

display_name

string

必須。ExpandedDataSet の表示名。最大 200 文字。

description

string

省略可。ExpandedDataSet の説明。最大 50 文字。

dimension_names[]

string

変更不可。ExpandedDataSet に含まれるディメンションのリスト。ディメンション名の一覧については、API ディメンションをご覧ください。

metric_names[]

string

変更不可。ExpandedDataSet に含まれる指標のリスト。ディメンション名の一覧については、API 指標をご覧ください。

dimension_filter_expression

ExpandedDataSetFilterExpression

変更不可。ExpandedDataSet に含まれるディメンションに適用される ExpandedDataSet フィルタの論理式。このフィルタは、行数を減らし、other 行が発生する可能性を低減するために使用されます。

data_collection_start_time

Timestamp

出力専用。拡張データセットでデータの収集が開始された(または開始される)時刻。

ExpandedDataSetFilter

単一ディメンションの特定のフィルタ

フィールド
field_name

string

必須。フィルタするディメンション名。

共用体フィールド one_filter。上記のフィルタのいずれか。one_filter は次のいずれかになります。
string_filter

StringFilter

特定のパターンに一致する文字列タイプのディメンションのフィルタ。

in_list_filter

InListFilter

特定のオプションのリストに一致する文字列ディメンションのフィルタ。

InListFilter

特定のオプションのリストに一致する文字列ディメンションのフィルタ。

フィールド
values[]

string

必須。照合する可能性のある文字列値のリスト。空でない必要があります。

case_sensitive

bool

省略可。true の場合、大文字と小文字が区別されます。false の場合、大文字と小文字は区別されません。true にする必要があります。

StringFilter

特定のパターンに一致する文字列タイプのディメンションのフィルタ。

フィールド
match_type

MatchType

必須。文字列フィルタのマッチタイプ。

value

string

必須。照合する文字列値。

case_sensitive

bool

省略可。true の場合、大文字と小文字が区別されます。false の場合、大文字と小文字は区別されません。match_type が EXACT の場合に true にする必要があります。match_type が CONTAINS の場合は false にする必要があります。

MatchType

文字列フィルタのマッチタイプ。

列挙型
MATCH_TYPE_UNSPECIFIED 指定なし
EXACT 文字列値の完全一致。
CONTAINS 文字列値が含まれます。

ExpandedDataSetFilterExpression

EnhancedDataSet ディメンション フィルタの論理式。

フィールド
共用体フィールド expr。フィルタに適用される式。expr は次のいずれかになります。
and_group

ExpandedDataSetFilterExpressionList

AND 演算で結合する式のリスト。not_expression または dimension_filter を含む ExpandedDataSetFilterExpression を含める必要があります。これは、最上位の ExpandedDataSetFilterExpression に設定する必要があります。

not_expression

ExpandedDataSetFilterExpression

NOT 演算(反転、補完)を適用するフィルタ式。dimension_filter を含める必要があります。これは、最上位の ExpandedDataSetFilterExpression では設定できません。

filter

ExpandedDataSetFilter

単一ディメンションでのフィルタ。これは、最上位の ExpandedDataSetFilterExpression では設定できません。

ExpandedDataSetFilterExpressionList

ExpandedDataSet フィルタ式のリスト。

フィールド
filter_expressions[]

ExpandedDataSetFilterExpression

ExpandedDataSet フィルタ式のリスト。

FetchAutomatedGa4ConfigurationOptOutRequest

GA4 の自動設定プロセスのオプトアウト ステータスの取得リクエスト。

フィールド
property

string

必須。オプトアウト ステータスを取得する UA プロパティ。このリクエストでは、UA-XXXXXX-YY 形式のトラッキング ID ではなく、内部プロパティ ID を使用します。形式: properties/{internalWebPropertyId} 例: properties/1234

FetchAutomatedGa4ConfigurationOptOutResponse

GA4 の自動設定プロセスのオプトアウト ステータスを取得するためのレスポンス メッセージ。

フィールド
opt_out

bool

UA プロパティのオプトアウト ステータス。

FetchConnectedGa4PropertyRequest

UA プロパティに接続されている GA4 プロパティの検索リクエスト。

フィールド
property

string

必須。接続された GA4 プロパティを検索する UA プロパティ。このリクエストでは、UA-XXXXXX-YY 形式のトラッキング ID ではなく、内部プロパティ ID を使用します。形式: properties/{internal_web_property_id} 例: properties/1234

FetchConnectedGa4PropertyResponse

UA プロパティに接続されている GA4 プロパティの検索結果。

フィールド
property

string

UA プロパティに接続されている GA4 プロパティ。接続された GA4 プロパティがない場合、空の文字列が返されます。形式: properties/{property_id} 例: properties/1234

GetAccessBindingRequest

GetAccessBinding RPC のリクエスト メッセージ。

フィールド
name

string

必須。取得するアクセス バインディングの名前。形式: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}

GetAccountRequest

GetAccount RPC のリクエスト メッセージ。

フィールド
name

string

必須。検索するアカウントの名前。形式: accounts/{account} 例: accounts/100

GetAdSenseLinkRequest

GetAdSenseLink メソッドに渡されるリクエスト メッセージ。

フィールド
name

string

必須。リクエストされた AdSense リンクの一意の識別子。形式: properties/{propertyId}/adSenseLinks/{linkId} 例: properties/1234/adSenseLinks/5678

GetAttributionSettingsRequest

GetAttributionSettings RPC のリクエスト メッセージ。

フィールド
name

string

必須。取得するアトリビューション設定の名前。形式: properties/{property}/attributionSettings

GetAudienceRequest

GetAudience RPC のリクエスト メッセージ。

フィールド
name

string

必須。取得するオーディエンスの名前。形式の例: properties/1234/audiences/5678

GetBigQueryLinkRequest

GetBigQueryLink RPC のリクエスト メッセージ。

フィールド
name

string

必須。検索する BigQuery リンクの名前。形式: properties/{property_id}/bigQueryLinks/{bigquery_link_id} 例: properties/123/bigQueryLinks/456

GetCalculatedMetricRequest

GetCalculatedMetric RPC のリクエスト メッセージ。

フィールド
name

string

必須。取得する CalculatedMetric の名前。形式: properties/{property_id}/calculatedMetrics/{calculated_metric_id} 例: properties/1234/calculatedMetrics/Metric01

GetChannelGroupRequest

GetChannelGroup RPC のリクエスト メッセージ。

フィールド
name

string

必須。取得する ChannelGroup。形式の例: properties/1234/channelGroups/5678

GetConversionEventRequest

GetConversionEvent RPC のリクエスト メッセージ

フィールド
name

string

必須。取得するコンバージョン イベントのリソース名。形式: properties/{property}/conversionEvents/{conversion_event} 例: "properties/123/conversionEvents/456"

GetCustomDimensionRequest

GetCustomDimension RPC のリクエスト メッセージ。

フィールド
name

string

必須。取得するカスタム ディメンションの名前。形式例: properties/1234/customDimensions/5678

GetCustomMetricRequest

GetCustomMetric RPC のリクエスト メッセージ。

フィールド
name

string

必須。取得する CustomMetric の名前。形式の例: properties/1234/customMetrics/5678

GetDataRedactionSettingsRequest

GetDataRedactionSettings RPC のリクエスト メッセージ。

フィールド
name

string

必須。検索する設定の名前。形式: properties/{property}/dataStreams/{data_stream}/dataRedactionSettings 例: "properties/1000/dataStreams/2000/dataRedactionSettings"

GetDataRetentionSettingsRequest

GetDataRetentionSettings RPC のリクエスト メッセージ。

フィールド
name

string

必須。検索する設定の名前。形式: properties/{property}/dataRetentionSettings 例: "properties/1000/dataRetentionSettings"

GetDataSharingSettingsRequest

GetDataSharingSettings RPC のリクエスト メッセージ。

フィールド
name

string

必須。検索する設定の名前。形式: accounts/{account}/dataSharingSettings

例: accounts/1000/dataSharingSettings

GetDataStreamRequest

GetDataStream RPC のリクエスト メッセージ。

フィールド
name

string

必須。取得する DataStream の名前。形式の例: properties/1234/dataStreams/5678

GetDisplayVideo360AdvertiserLinkProposalRequest

GetDisplayVideo360AdvertiserLinkProposal RPC のリクエスト メッセージ。

フィールド
name

string

必須。取得する DisplayVideo360AdvertiserLinkProposal の名前。形式の例: properties/1234/displayVideo360AdvertiserLinkProposals/5678

GetDisplayVideo360AdvertiserLinkRequest

GetDisplayVideo360AdvertiserLink RPC のリクエスト メッセージ。

フィールド
name

string

必須。取得する DisplayVideo360AdvertiserLink の名前。形式の例: properties/1234/displayVideo360AdvertiserLink/5678

GetEnhancedMeasurementSettingsRequest

GetEnhancedMeasurementSettings RPC のリクエスト メッセージ。

フィールド
name

string

必須。検索する設定の名前。形式: properties/{property}/dataStreams/{data_stream}/enhancedMeasurementSettings 例: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"

GetEventCreateRuleRequest

GetEventCreateRule RPC のリクエスト メッセージ。

フィールド
name

string

必須。取得する EventCreateRule の名前。形式の例: properties/123/dataStreams/456/eventCreateRules/789

GetEventEditRuleRequest

GetEventEditRule RPC のリクエスト メッセージ。

フィールド
name

string

必須。取得する EventEditRule の名前。形式の例: properties/123/dataStreams/456/eventEditRules/789

GetExpandedDataSetRequest

GetExpandedDataSet RPC のリクエスト メッセージ。

フィールド
name

string

必須。取得する ExpandedDataSet の名前。形式の例: properties/1234/expandedDataSets/5678

GetGlobalSiteTagRequest

GetGlobalSiteTag RPC のリクエスト メッセージ。

フィールド
name

string

必須。検索するサイトタグの名前。サイトタグはシングルトンであり、一意の ID はありません。形式: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag

例: properties/123/dataStreams/456/globalSiteTag

GetGoogleSignalsSettingsRequest

GetGoogleSignalsSettings RPC のリクエスト メッセージ

フィールド
name

string

必須。取得する Google シグナル設定の名前。形式: properties/{property}/googleSignalsSettings

GetKeyEventRequest

GetKeyEvent RPC のリクエスト メッセージ

フィールド
name

string

必須。取得するキーイベントのリソース名。形式: properties/{property}/keyEvents/{key_event} 例: "properties/123/keyEvents/456"

GetMeasurementProtocolSecretRequest

GetMeasurementProtocolSecret RPC のリクエスト メッセージ。

フィールド
name

string

必須。検索する測定プロトコル シークレットの名前。形式: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

GetPropertyRequest

GetProperty RPC のリクエスト メッセージ。

フィールド
name

string

必須。検索するプロパティの名前。形式: properties/{property_id} 例: "properties/1000"

GetReportingDataAnnotationRequest

GetReportingDataAnnotation RPC のリクエスト メッセージ。

フィールド
name

string

必須。検索するレポートデータ アノテーションのリソース名。形式: properties/property_id/reportingDataAnnotations/reportingDataAnnotation 例: properties/123/reportingDataAnnotations/456

GetRollupPropertySourceLinkRequest

GetRollupPropertySourceLink RPC のリクエスト メッセージ。

フィールド
name

string

必須。検索する統合プロパティの参照元リンクの名前。形式: properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} 例: properties/123/rollupPropertySourceLinks/456

GetSKAdNetworkConversionValueSchemaRequest

GetSKAdNetworkConversionValueSchema RPC のリクエスト メッセージ。

フィールド
name

string

必須。検索する SKAdNetwork コンバージョン値スキーマのリソース名。Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}

GetSearchAds360LinkRequest

GetSearchAds360Link RPC のリクエスト メッセージ。

フィールド
name

string

必須。取得する SearchAds360Link の名前。形式例: properties/1234/SearchAds360Link/5678

GetSubpropertyEventFilterRequest

GetSubpropertyEventFilter RPC のリクエスト メッセージ。

フィールド
name

string

必須。検索するサブプロパティ イベント フィルタのリソース名。形式: properties/property_id/subpropertyEventFilters/subproperty_event_filter 例: properties/123/subpropertyEventFilters/456

GetSubpropertySyncConfigRequest

GetSubpropertySyncConfig RPC のリクエスト メッセージ。

フィールド
name

string

必須。検索する SubpropertySyncConfig のリソース名。形式: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} 例: properties/1234/subpropertySyncConfigs/5678

GlobalSiteTag

ウェブサイトから DataStream にデータを送信するためのタグを含む読み取り専用リソース。ウェブ DataStream リソースにのみ存在します。

フィールド
name

string

出力専用。この GlobalSiteTag リソースのリソース名。形式: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag 例: "properties/123/dataStreams/456/globalSiteTag"

snippet

string

変更不可。測定するすべてのウェブページの head タグの最初の要素として貼り付ける JavaScript コード スニペット。

GoogleSignalsConsent

Google シグナルの設定の同意フィールド。

列挙型

GoogleSignalsSettings

Google シグナルの設定値。これはシングルトン リソースです。

フィールド
name

string

出力専用。この設定のリソース名。形式: properties/{property_id}/googleSignalsSettings 例: "properties/1000/googleSignalsSettings"

state

GoogleSignalsState

この設定のステータス。

consent

GoogleSignalsConsent

出力専用。利用規約への同意。

GoogleSignalsState

Google シグナルの設定のステータス。

列挙型
GOOGLE_SIGNALS_STATE_UNSPECIFIED Google シグナルのステータスはデフォルトで GOOGLE_SIGNALS_STATE_UNSPECIFIED に設定され、ユーザーが明示的に選択していないことを示します。
GOOGLE_SIGNALS_ENABLED Google シグナルが有効になっている。
GOOGLE_SIGNALS_DISABLED Google シグナルが無効になっている。

GroupingRule

トラフィックを 1 つのチャネルにグループ化する方法を管理するルール。

フィールド
display_name

string

必須。チャンネルのカスタマー定義の表示名。

expression

ChannelGroupFilterExpression

必須。グループ化ルールを定義するフィルタ式。

IndustryCategory

このプロパティに選択されたカテゴリ。業種のベンチマークに使用されます。

列挙型
INDUSTRY_CATEGORY_UNSPECIFIED 業種が指定されていません
AUTOMOTIVE 自動車
BUSINESS_AND_INDUSTRIAL_MARKETS ビジネス、製造
FINANCE 金融
HEALTHCARE 医療
TECHNOLOGY テクノロジー
TRAVEL 旅行
OTHER その他
ARTS_AND_ENTERTAINMENT アート、エンターテインメント
BEAUTY_AND_FITNESS 美容、フィットネス
BOOKS_AND_LITERATURE 書籍、文学
FOOD_AND_DRINK 食べ物と飲み物
GAMES ゲーム
HOBBIES_AND_LEISURE 趣味、レジャー
HOME_AND_GARDEN 家庭、園芸
INTERNET_AND_TELECOM インターネット、通信
LAW_AND_GOVERNMENT 法律、行政
NEWS ニュース
ONLINE_COMMUNITIES オンライン コミュニティ
PEOPLE_AND_SOCIETY 人々、社会
PETS_AND_ANIMALS ペット、動物
REAL_ESTATE 不動産
REFERENCE リファレンス
SCIENCE 科学
SPORTS スポーツ
JOBS_AND_EDUCATION 人材募集、職業訓練
SHOPPING ショッピング

KeyEvent

Google アナリティクス プロパティのキーイベント。

フィールド
name

string

出力専用。このキーイベントのリソース名。形式: properties/{property}/keyEvents/{key_event}

event_name

string

変更不可。このキーイベントのイベント名。例: 「click」、「purchase」

create_time

Timestamp

出力専用。このキーイベントがプロパティで作成された日時。

deletable

bool

出力専用。true に設定すると、このイベントは削除できます。

custom

bool

出力専用。true に設定すると、このキーイベントはカスタム イベントを参照します。false に設定した場合、このキーイベントは GA のデフォルト イベントを参照します。デフォルト イベントは通常、GA で特別な意味を持つイベントです。デフォルト イベントは通常、GA システムによって自動的に作成されますが、プロパティ管理者が作成することもできます。カスタム イベントは、プロパティごとに作成できるカスタム キーイベントの最大数にカウントされます。

counting_method

CountingMethod

必須。セッション内の複数のイベントでキーイベントをカウントする方法。

default_value

DefaultValue

省略可。キーイベントのデフォルト値/通貨を定義します。

CountingMethod

セッション内の複数のイベントでキーイベントをカウントする方法。

列挙型
COUNTING_METHOD_UNSPECIFIED カウント方法が指定されていません。
ONCE_PER_EVENT 各 Event インスタンスはキーイベントと見なされます。
ONCE_PER_SESSION イベント インスタンスは、ユーザーごとにセッションごとに最大 1 回キーイベントと見なされます。

DefaultValue

キーイベントのデフォルト値/通貨を定義します。

フィールド
numeric_value

double

必須。この値は、このキーイベント(event_name で指定)のすべての発生で、そのパラメータが未設定の場合に「value」パラメータに入力されます。

currency_code

string

必須。このキーイベント(event_name で指定)の発生時に通貨が設定されていない場合、この通貨がデフォルトとして適用されます。ISO 4217 通貨コードの形式で指定する必要があります。

詳細については、https://en.wikipedia.org/wiki/ISO_4217 をご覧ください。

LinkProposalInitiatingProduct

ユーザーがリンク提案を開始したプロダクトを示す。

列挙型
GOOGLE_ANALYTICS この提案は、Google アナリティクスのユーザーによって作成されました。
LINKED_PRODUCT この提案は、リンクされたプロダクト(Google アナリティクス以外)のユーザーによって作成されました。

LinkProposalState

リンク候補リソースの状態。

列挙型
AWAITING_REVIEW_FROM_GOOGLE_ANALYTICS この提案は、Google アナリティクスのユーザーによる審査待ちです。この提案はしばらくすると自動的に期限切れになります。
AWAITING_REVIEW_FROM_LINKED_PRODUCT この提案は、リンクされたプロダクトのユーザーによる審査待ちです。この提案はしばらくすると自動的に期限切れになります。
WITHDRAWN このプロポーザルは、開始元のプロダクトの管理者によって取り消されました。この提案はしばらくすると自動的に削除されます。
DECLINED この提案は、受信側のプロダクトの管理者によって不承認となりました。この提案はしばらくすると自動的に削除されます。
EXPIRED 受信側のプロダクトの管理者から回答がなかったため、この提案は期限切れになりました。この提案はしばらくすると自動的に削除されます。
OBSOLETE このプロポーザルで指定されている外部プロダクト リソースへのリンクが直接作成されたため、このプロポーザルは廃止されました。この提案はしばらくすると自動的に削除されます。

LinkProposalStatusDetails

リンク プロポーザルのステータス情報。

フィールド
requestor_email

string

出力専用。このリンクを提案したユーザーのメールアドレス。

ListAccessBindingsRequest

ListAccessBindings RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式: - accounts/{account} - properties/{property}

page_size

int32

返されるアクセス バインディングの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合は、最大で 200 個のアクセス バインディングが返されます。最大値は 500 です。500 を超える値は 500 に強制変換されます。

page_token

string

前回の ListAccessBindings 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。ページネーションを行う場合、ListAccessBindings に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

ListAccessBindingsResponse

ListAccessBindings RPC のレスポンス メッセージ。

フィールド
access_bindings[]

AccessBinding

AccessBinding のリスト。これらの順序は安定していますが、任意の順序になります。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListAccountSummariesRequest

ListAccountSummaries RPC のリクエスト メッセージ。

フィールド
page_size

int32

返される AccountSummary リソースの最大数。ページが他にあっても、サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

前回の ListAccountSummaries 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。ページネーションを行う場合、ListAccountSummaries に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

ListAccountSummariesResponse

ListAccountSummaries RPC のレスポンス メッセージ。

フィールド
account_summaries[]

AccountSummary

呼び出し元がアクセスできるすべてのアカウントのアカウント概要。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListAccountsRequest

ListAccounts RPC のリクエスト メッセージ。

フィールド
page_size

int32

返されるリソースの最大数。ページが他にあっても、サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

前回の ListAccounts 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。ページネーションを行う場合、ListAccounts に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

show_deleted

bool

削除(復元可能)されたアカウント(「ゴミ箱に移動」されたアカウント)を結果に含めるかどうか。アカウントを検査して、削除されているかどうかを確認できます。

ListAccountsResponse

ListAccounts RPC のリクエスト メッセージ。

フィールド
accounts[]

Account

呼び出し元がアクセスできる結果。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListAdSenseLinksRequest

ListAdSenseLinks メソッドに渡されるリクエスト メッセージ。

フィールド
parent

string

必須。親プロパティのリソース名。形式: properties/{propertyId} 例: properties/1234

page_size

int32

返されるリソースの最大数。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

前回の ListAdSenseLinks 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListAdSenseLinks に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListAdSenseLinksResponse

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

フィールド
next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListAudiencesRequest

ListAudiences RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/1234

page_size

int32

返されるリソースの最大数。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

前回の ListAudiences 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListAudiences に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListAudiencesResponse

ListAudiences RPC のレスポンス メッセージ。

フィールド
audiences[]

Audience

オーディエンスのリスト。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListBigQueryLinksRequest

ListBigQueryLinks RPC のリクエスト メッセージ。

フィールド
parent

string

必須。BigQuery リンクを表示するプロパティの名前。形式: properties/{property_id} 例: properties/1234

page_size

int32

返されるリソースの最大数。ページが他にあっても、サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

前回の ListBigQueryLinks 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。ページネーションを行う場合、ListBigQueryLinks に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

ListBigQueryLinksResponse

ListBigQueryLinks RPC のレスポンス メッセージ

フィールド
next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListCalculatedMetricsRequest

ListCalculatedMetrics RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/1234

page_size

int32

省略可。返されるリソースの最大数。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

省略可。前回の ListCalculatedMetrics 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListCalculatedMetrics に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListCalculatedMetricsResponse

ListCalculatedMetrics RPC に対するレスポンス メッセージ。

フィールド
calculated_metrics[]

CalculatedMetric

CalculatedMetrics のリスト。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListChannelGroupsRequest

ListChannelGroups RPC のリクエスト メッセージ。

フィールド
parent

string

必須。ChannelGroups を一覧表示するプロパティ。形式の例: properties/1234

page_size

int32

返されるリソースの最大数。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

前回の ListChannelGroups 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListChannelGroups に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListChannelGroupsResponse

ListChannelGroups RPC のレスポンス メッセージ。

フィールド
channel_groups[]

ChannelGroup

ChannelGroup のリスト。これらの順序は安定していますが、任意の順序になります。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListConnectedSiteTagsRequest

ListConnectedSiteTags RPC のリクエスト メッセージ。

フィールド
property

string

接続済みのサイトタグを取得するユニバーサル アナリティクス プロパティ。GA4 プロパティでは機能しません。返される接続済みのサイトタグの最大数は 20 個です。形式例: properties/1234

ListConnectedSiteTagsResponse

ListConnectedSiteTags RPC のレスポンス メッセージ。

フィールド
connected_site_tags[]

ConnectedSiteTag

ユニバーサル アナリティクス プロパティのサイトタグ。返される接続済みのサイトタグの最大数は 20 個です。

ListConversionEventsRequest

ListConversionEvents RPC のリクエスト メッセージ

フィールド
parent

string

必須。親プロパティのリソース名。例: 'properties/123'

page_size

int32

返されるリソースの最大数。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

前回の ListConversionEvents 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。ページネーションを行う場合、ListConversionEvents に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

ListConversionEventsResponse

ListConversionEvents RPC に対するレスポンス メッセージ。

フィールド
conversion_events[]

ConversionEvent

リクエストされたコンバージョン イベント

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListCustomDimensionsRequest

ListCustomDimensions RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/1234

page_size

int32

返されるリソースの最大数。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

前回の ListCustomDimensions 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListCustomDimensions に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListCustomDimensionsResponse

ListCustomDimensions RPC に対するレスポンス メッセージ。

フィールド
custom_dimensions[]

CustomDimension

CustomDimensions のリスト。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListCustomMetricsRequest

ListCustomMetrics RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/1234

page_size

int32

返されるリソースの最大数。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

前回の ListCustomMetrics 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListCustomMetrics に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListCustomMetricsResponse

ListCustomMetrics RPC に対するレスポンス メッセージ。

フィールド
custom_metrics[]

CustomMetric

CustomMetrics のリスト。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListDataStreamsRequest

ListDataStreams RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/1234

page_size

int32

返されるリソースの最大数。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

前回の ListDataStreams 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListDataStreams に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListDataStreamsResponse

ListDataStreams RPC のレスポンス メッセージ。

フィールド
data_streams[]

DataStream

DataStream のリスト。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListDisplayVideo360AdvertiserLinkProposalsRequest

ListDisplayVideo360AdvertiserLinkProposals RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/1234

page_size

int32

返されるリソースの最大数。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

前回の ListDisplayVideo360AdvertiserLinkProposals 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListDisplayVideo360AdvertiserLinkProposals に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListDisplayVideo360AdvertiserLinkProposalsResponse

ListDisplayVideo360AdvertiserLinkProposals RPC のレスポンス メッセージ。

フィールド
next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListDisplayVideo360AdvertiserLinksRequest

ListDisplayVideo360AdvertiserLinks RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/1234

page_size

int32

返されるリソースの最大数。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

前回の ListDisplayVideo360AdvertiserLinks 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListDisplayVideo360AdvertiserLinks に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListDisplayVideo360AdvertiserLinksResponse

ListDisplayVideo360AdvertiserLinks RPC のレスポンス メッセージ。

フィールド
next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListEventCreateRulesRequest

ListEventCreateRules RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/123/dataStreams/456

page_size

int32

返されるリソースの最大数。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

前回の ListEventCreateRules 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListEventCreateRules に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListEventCreateRulesResponse

ListEventCreateRules RPC に対するレスポンス メッセージ。

フィールド
event_create_rules[]

EventCreateRule

EventCreateRule のリスト。これらの順序は安定していますが、任意の順序になります。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListEventEditRulesRequest

ListEventEditRules RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/123/dataStreams/456

page_size

int32

省略可。返されるリソースの最大数。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

省略可。前回の ListEventEditRules 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListEventEditRules に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListEventEditRulesResponse

ListEventEditRules RPC に対するレスポンス メッセージ。

フィールド
event_edit_rules[]

EventEditRule

EventEditRules のリスト。これらの順序は安定していますが、任意の順序になります。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListExpandedDataSetsRequest

ListExpandedDataSets RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/1234

page_size

int32

返されるリソースの最大数。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

前回の ListExpandedDataSets 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListExpandedDataSet に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListExpandedDataSetsResponse

ListExpandedDataSets RPC のレスポンス メッセージ。

フィールド
expanded_data_sets[]

ExpandedDataSet

ExpandedDataSet のリスト。これらの順序は安定していますが、任意の順序になります。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListFirebaseLinksRequest

ListFirebaseLinks RPC のリクエスト メッセージ

フィールド
parent

string

必須。形式: properties/{property_id}

例: properties/1234

page_size

int32

返されるリソースの最大数。ページが他にあっても、サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

前回の ListFirebaseLinks 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。ページネーションを行う場合、ListFirebaseLinks に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

ListFirebaseLinksResponse

ListFirebaseLinks RPC のレスポンス メッセージ

フィールド
next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。現在、Google アナリティクスではプロパティごとに 1 つの FirebaseLink のみがサポートされているため、このフィールドには値が入力されません。

ListGoogleAdsLinksRequest

ListGoogleAdsLinks RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/1234

page_size

int32

返されるリソースの最大数。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

前回の ListGoogleAdsLinks 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListGoogleAdsLinks に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListGoogleAdsLinksResponse

ListGoogleAdsLinks RPC のレスポンス メッセージ。

フィールド
next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListKeyEventsRequest

ListKeyEvents RPC のリクエスト メッセージ

フィールド
parent

string

必須。親プロパティのリソース名。例: 'properties/123'

page_size

int32

返されるリソースの最大数。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

前回の ListKeyEvents 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。ページネーションを行う場合、ListKeyEvents に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

ListKeyEventsResponse

ListKeyEvents RPC に対するレスポンス メッセージ。

フィールド
key_events[]

KeyEvent

リクエストされたキーイベント

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListMeasurementProtocolSecretsRequest

ListMeasurementProtocolSecret RPC のリクエスト メッセージ

フィールド
parent

string

必須。親ストリームのリソース名。形式: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets

page_size

int32

返されるリソースの最大数。指定されていない場合は、最大で 10 個のリソースが返されます。最大値は 10 です。値が最大値を超える場合は、最大値に強制変換されます。

page_token

string

前回の ListMeasurementProtocolSecrets 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。ページネーションを行う場合、ListMeasurementProtocolSecrets に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

ListMeasurementProtocolSecretsResponse

ListMeasurementProtocolSecret RPC に対するレスポンス メッセージ

フィールド
measurement_protocol_secrets[]

MeasurementProtocolSecret

リクエストで指定された親ストリームのシークレットのリスト。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListPropertiesRequest

ListProperties RPC のリクエスト メッセージ。

フィールド
filter

string

必須。リクエストの結果をフィルタリングする式。フィルタリングが利用できるフィールドは、parent:(親アカウント/プロパティのリソース名)、ancestor:(親アカウントのリソース名)、firebase_project:(リンクされた Firebase プロジェクトの ID または番号)です。フィルタの例:

| Filter                      | Description                               |
|-----------------------------|-------------------------------------------|
| parent:accounts/123         | The account with account id: 123.       |
| parent:properties/123       | The property with property id: 123.       |
| ancestor:accounts/123       | The account with account id: 123.         |
| firebase_project:project-id | The firebase project with id: project-id. |
| firebase_project:123        | The firebase project with number: 123.    |
page_size

int32

返されるリソースの最大数。ページが他にあっても、サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

前回の ListProperties 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。ページネーションを行う場合、ListProperties に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

show_deleted

bool

削除(復元可能)(「ゴミ箱に移動済み」)のプロパティを結果に含めるかどうか。プロパティを検査して、削除されているかどうかを確認できます。

ListPropertiesResponse

ListProperties RPC に対するレスポンス メッセージ。

フィールド
properties[]

Property

フィルタ条件に一致し、呼び出し元がアクセスできる結果。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListReportingDataAnnotationsRequest

ListReportingDataAnnotation RPC のリクエスト メッセージ。

フィールド
parent

string

必須。プロパティのリソース名。形式: properties/property_id 例: properties/123

filter

string

省略可。親プロパティのレポートデータ アノテーションの一覧表示を制限するフィルタ。

サポートされているフィールドは次のとおりです。

  • 'name'
  • title
  • description
  • annotation_date
  • annotation_date_range
  • color

また、この API には次のヘルパー関数があります。

  • annotation_duration() : このアノテーションがマークする時間(durations)。秒数を数値で指定し、末尾に s を付けます。
  • is_annotation_in_range(start_date, end_date) : アノテーションが start_dateend_date で指定された範囲内にあるかどうか。日付は ISO-8601 形式で指定します(例: 2031-06-28)。

サポートされているオペレーション:

  • = : 等しい
  • != : 等しくない
  • < : 小さい
  • > : 大きい
  • <= : 小さいまたは等しい
  • >= : 大きいまたは同じ
  • : : has 演算子
  • =~ : 正規表現の一致
  • !~ : 正規表現が一致しない
  • NOT : 論理否定
  • AND : 論理 AND
  • OR : 論理 OR

例:

  1. title="Holiday Sale"
  2. description=~"[Bb]ig [Gg]ame.*[Ss]ale"
  3. is_annotation_in_range("2025-12-25", "2026-01-16") = true
  4. annotation_duration() >= 172800s AND title:BOGO
page_size

int32

省略可。返されるリソースの最大数。ページが他にあっても、サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

省略可。前回の ListReportingDataAnnotations 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。ページネーションを行う場合、ListReportingDataAnnotations に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

ListReportingDataAnnotationsResponse

ListReportingDataAnnotation RPC に対するレスポンス メッセージ。

フィールド
reporting_data_annotations[]

ReportingDataAnnotation

レポートデータ アノテーションのリスト。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListRollupPropertySourceLinksRequest

ListRollupPropertySourceLinks RPC のリクエスト メッセージ。

フィールド
parent

string

必須。統合プロパティの参照元リンクを表示する統合プロパティの名前。形式: properties/{property_id} 例: properties/1234

page_size

int32

省略可。返されるリソースの最大数。ページが他にあっても、サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

省略可。前回の ListRollupPropertySourceLinks 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。ページネーションを行う場合、ListRollupPropertySourceLinks に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

ListRollupPropertySourceLinksResponse

ListRollupPropertySourceLinks RPC に対するレスポンス メッセージ。

フィールド
next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListSKAdNetworkConversionValueSchemasRequest

ListSKAdNetworkConversionValueSchemas RPC のリクエスト メッセージ

フィールド
parent

string

必須。スキーマを一覧表示する DataStream リソース。形式: properties/{property_id}/dataStreams/{dataStream} 例: properties/1234/dataStreams/5678

page_size

int32

返されるリソースの最大数。ページが他にあっても、サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

前回の ListSKAdNetworkConversionValueSchemas 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。ページネーションを行う場合、ListSKAdNetworkConversionValueSchema に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

ListSKAdNetworkConversionValueSchemasResponse

ListSKAdNetworkConversionValueSchemas RPC に対するレスポンス メッセージ

フィールド
skadnetwork_conversion_value_schemas[]

SKAdNetworkConversionValueSchema

SKAdNetworkConversionValueSchema のリスト。値は 1 つまでです。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。現在、Google アナリティクスでは dataStream ごとに 1 つの SKAdNetworkConversionValueSchema のみがサポートされているため、このフィールドに値が入力されることはありません。

ListSearchAds360LinksRequest

ListSearchAds360Links RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/1234

page_size

int32

返されるリソースの最大数。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

前回の ListSearchAds360Links 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。

ページ分割を行う場合、ListSearchAds360Links に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

ListSearchAds360LinksResponse

ListSearchAds360Links RPC に対するレスポンス メッセージ。

フィールド
next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListSubpropertyEventFiltersRequest

ListSubpropertyEventFilters RPC のリクエスト メッセージ。

フィールド
parent

string

必須。通常のプロパティのリソース名。形式: properties/property_id 例: properties/123

page_size

int32

省略可。返されるリソースの最大数。ページが他にあっても、サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

省略可。前回の ListSubpropertyEventFilters 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。ページネーションを行う場合、ListSubpropertyEventFilters に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

ListSubpropertyEventFiltersResponse

ListSubpropertyEventFilter RPC のレスポンス メッセージ。

フィールド
subproperty_event_filters[]

SubpropertyEventFilter

サブプロパティ イベント フィルタのリスト。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListSubpropertySyncConfigsRequest

ListSubpropertySyncConfigs RPC のリクエスト メッセージ。

フィールド
parent

string

必須。プロパティのリソース名。形式: properties/property_id 例: properties/123

page_size

int32

省略可。返されるリソースの最大数。ページが他にあっても、サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のリソースが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

page_token

string

省略可。前回の ListSubpropertySyncConfig 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。ページネーションを行う場合、ListSubpropertySyncConfig に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

ListSubpropertySyncConfigsResponse

ListSubpropertySyncConfigs RPC のレスポンス メッセージ。

フィールド
subproperty_sync_configs[]

SubpropertySyncConfig

SubpropertySyncConfig リソースのリスト。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

MatchingCondition

イベントの編集ルールまたはイベントの作成ルールがイベントに適用される条件を定義します。

フィールド
field

string

必須。条件で比較されるフィールドの名前。「event_name」が指定されている場合、この条件はイベント名に適用されます。指定されていない場合は、指定された名前のパラメータに条件が適用されます。

この値にスペースを含めることはできません。

comparison_type

ComparisonType

必須。値に適用される比較のタイプ。

value

string

必須。この条件で比較される値。ランタイム実装では、この値の型変換が行われ、パラメータ値の型に基づいてこの条件が評価される場合があります。

negated

bool

比較結果を否定するかどうか。たとえば、negated が true の場合、「等しい」比較は「等しくない」として機能します。

ComparisonType

一致条件の比較タイプ

列挙型
COMPARISON_TYPE_UNSPECIFIED 不明
EQUALS 等しい(大文字と小文字を区別)
EQUALS_CASE_INSENSITIVE 等しい(大文字と小文字を区別しない)
CONTAINS 次を含む(大文字と小文字を区別)
CONTAINS_CASE_INSENSITIVE 次を含む(大文字と小文字を区別しない)
STARTS_WITH 次で始まる(大文字と小文字を区別)
STARTS_WITH_CASE_INSENSITIVE 次で始まる(大文字と小文字を区別しない)
ENDS_WITH 末尾が一致(大文字と小文字を区別)
ENDS_WITH_CASE_INSENSITIVE 次で終わる(大文字と小文字を区別しない)
GREATER_THAN 次より大きい
GREATER_THAN_OR_EQUAL 以上
LESS_THAN 次より小さい
LESS_THAN_OR_EQUAL 次の値以下
REGULAR_EXPRESSION 正規表現。ウェブ ストリームでのみサポートされます。
REGULAR_EXPRESSION_CASE_INSENSITIVE 正規表現(大文字と小文字を区別しない)。ウェブ ストリームでのみサポートされます。

MeasurementProtocolSecret

Measurement Protocol にヒットを送信するために使用されるシークレット値。

フィールド
name

string

出力専用。このシークレットのリソース名。このシークレットは、任意のタイプのストリームの子にできます。形式: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

display_name

string

必須。このシークレットの表示名(人が読める形式)。

secret_value

string

出力専用。Measurement Protocol のシークレットの値。この値は、このシークレットの親プロパティにヒットを送信するときに、Measurement Protocol API の api_secret フィールドに渡します。

NumericValue

数値を表す。

フィールド
共用体フィールド one_value。数値 one_value は、次のいずれか 1 つだけにする必要があります。
int64_value

int64

整数値

double_value

double

double 値

ParameterMutation

変換するイベント パラメータを定義します。

フィールド
parameter

string

必須。変更するパラメータの名前。この値は、* 40 文字未満で指定する必要があります。* ルール内のすべてのミューテーションで一意である * 文字、数字、アンダースコア(_)のみで構成されている イベント編集ルールの場合、名前を「event_name」に設定して、event_name をその場で変更することもできます。

parameter_value

string

必須。実行する値のミューテーション。* 100 文字未満にする必要があります。* パラメータに定数値を指定するには、値の文字列を使用します。* 別のパラメータから値をコピーするには、「[[other_parameter]]」などの構文を使用します。詳しくは、こちらのヘルプセンター記事をご覧ください。

PostbackWindow

SKAdNetwork コンバージョン ポストバック ウィンドウの設定。

フィールド
conversion_values[]

ConversionValues

繰り返しフィールドの順序付けは、コンバージョン値の設定の優先度付けに使用されます。インデックス番号が小さいエントリの方が優先度が高くなります。true と評価された最初のコンバージョン値の設定が選択されます。enable_postback_window_settings が true に設定されている場合は、少なくとも 1 つのエントリが必要です。最大 128 個のエントリを指定できます。

postback_window_settings_enabled

bool

enable_postback_window_settings が true の場合、conversion_values に値を入力する必要があります。この値は、クライアント デバイスでコンバージョン値を設定するタイミングと方法を決定し、リンクされた Google 広告アカウントにスキーマをエクスポートするために使用されます。false の場合、設定は使用されませんが、将来使用される可能性があるため保持されます。postback_window_one の場合は常に true にする必要があります。

プロパティ

Google アナリティクスのプロパティを表すリソース メッセージ。

フィールド
name

string

出力専用。このプロパティのリソース名。形式: properties/{property_id} 例: "properties/1000"

property_type

PropertyType

変更不可。この Property リソースのプロパティタイプ。プロパティを作成するときに、タイプが「PROPERTY_TYPE_UNSPECIFIED」の場合、「ORDINARY_PROPERTY」が暗黙的に指定されます。

create_time

Timestamp

出力専用。エンティティが最初に作成された時刻。

update_time

Timestamp

出力専用。エンティティ ペイロード フィールドが最後に更新された時刻。

parent

string

変更不可。このプロパティの論理親のリソース名。

注: 宿泊施設の移動 UI を使用して親を変更できます。形式: accounts/{account}、properties/{property} 例: "accounts/100"、"properties/101"

display_name

string

必須。このプロパティの表示名(人が読める形式)。

表示名の最大長は 100 UTF-16 コード単位です。

industry_category

IndustryCategory

このプロパティに関連付けられている業種(例: AUTOMOTIVE、FOOD_AND_DRINK)

time_zone

string

必須。レポートのタイムゾーン: データの発生元に関係なく、レポートの日付の基準として使用されます。タイムゾーンで夏時間が採用されている場合、アナリティクスで自動的に時間調整が行われます。

注: タイムゾーンの変更は、それ以降に収集されるデータのみに反映され、過去のデータには適用されません。

形式: https://www.iana.org/time-zones 例: 「America/Los_Angeles」

currency_code

string

金額を含むレポートで使用される通貨の種類。

形式: https://en.wikipedia.org/wiki/ISO_4217 例: 「USD」、「EUR」、「JPY」

service_level

ServiceLevel

出力専用。このプロパティに適用される Google アナリティクスのサービスレベル。

delete_time

Timestamp

出力専用。設定されている場合、このプロパティがゴミ箱に移動された時刻。設定されていない場合、このプロパティは現在ゴミ箱にありません。

expire_time

Timestamp

出力専用。設定されている場合、このゴミ箱に移動されたプロパティが完全に削除される時刻。設定されていない場合、このプロパティは現在ゴミ箱になく、削除の予定もありません。

account

string

変更不可。親アカウントのリソース名。形式: accounts/{account_id} 例: accounts/123

PropertySummary

Google アナリティクス プロパティのメタデータを表す仮想リソース。

フィールド
property

string

このプロパティの概要で参照されているプロパティのリソース名。形式: properties/{property_id} 例: "properties/1000"

display_name

string

このプロパティの概要で参照されているプロパティの表示名。

property_type

PropertyType

宿泊施設のプロパティタイプ。

parent

string

このプロパティの論理親のリソース名。

注: 宿泊施設の移動 UI を使用して親を変更できます。形式: accounts/{account}、properties/{property} 例: "accounts/100"、"properties/200"

PropertyType

Property リソースのタイプ。

列挙型
PROPERTY_TYPE_UNSPECIFIED 不明または未指定のプロパティ タイプ
PROPERTY_TYPE_ORDINARY 通常の Google アナリティクスのプロパティ
PROPERTY_TYPE_SUBPROPERTY Google アナリティクスのサブプロパティ
PROPERTY_TYPE_ROLLUP Google アナリティクスの統合プロパティ

ProvisionAccountTicketRequest

ProvisionAccountTicket RPC のリクエスト メッセージ。

フィールド
account

Account

作成するアカウント。

redirect_uri

string

利用規約に同意した後にユーザーがリダイレクトされる URI。Cloud コンソールでリダイレクト URI として構成する必要があります。

ProvisionAccountTicketResponse

ProvisionAccountTicket RPC のレスポンス メッセージ。

フィールド
account_ticket_id

string

利用規約のリンクで渡されるパラメータ。

ProvisionSubpropertyRequest

CreateSubproperty RPC のリクエスト メッセージ。

フィールド
subproperty

Property

必須。作成するサブプロパティ。

subproperty_event_filter

SubpropertyEventFilter

省略可。通常のプロパティに作成するサブプロパティ イベント フィルタ。

custom_dimension_and_metric_synchronization_mode

SynchronizationMode

省略可。カスタム ディメンションとカスタム指標のサブプロパティ機能の同期モード

ProvisionSubpropertyResponse

ProvisionSubproperty RPC のレスポンス メッセージ。

フィールド
subproperty

Property

作成したサブプロパティ。

subproperty_event_filter

SubpropertyEventFilter

作成したサブプロパティ イベント フィルタ。

ReorderEventEditRulesRequest

ReorderEventEditRules RPC のリクエスト メッセージ。

フィールド
parent

string

必須。形式の例: properties/123/dataStreams/456

event_edit_rules[]

string

必須。指定されたデータ ストリームの EventEditRule リソース名(必要な処理順序で指定)。ストリームのすべての EventEditRule がリストに存在している必要があります。

ReportingDataAnnotation

レポートデータのアノテーションは、レポートデータの特定の日付に関連付けられたコメントです。

フィールド
name

string

必須。ID。このレポートデータ アノテーションのリソース名。形式: 'properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}' 形式: 'properties/123/reportingDataAnnotations/456'

title

string

必須。このレポートデータ アノテーションのタイトル(人が読める形式)。

description

string

省略可。このレポートデータ アノテーションの説明。

color

Color

必須。このレポートデータ アノテーションの表示に使用される色。

system_generated

bool

出力専用。true の場合、このアノテーションは Google アナリティクス システムによって生成されたものです。システム生成のアノテーションは更新または削除できません。

共用体フィールド target。このレポートデータ アノテーション target のターゲットは、次のいずれかになります。
annotation_date

Date

設定されている場合、レポートデータ アノテーションは、このフィールドで表される特定の日付に関するものです。日付は、年、月、日が設定された有効な日付である必要があります。過去、現在、未来の日付を指定できます。

annotation_date_range

DateRange

設定されている場合、レポートデータ アノテーションは、このフィールドで表される期間のものです。

このレポートデータ アノテーションに使用できる色

列挙型
COLOR_UNSPECIFIED 色が不明または指定されていません。
PURPLE 紫色。
BROWN 茶色。
BLUE 青色。
GREEN 緑色。
RED 赤色。
CYAN シアン色。
ORANGE オレンジ色。(システム生成アノテーションにのみ使用)

DateRange

レポートデータ アノテーションの期間を表します。開始日と終了日の両方が含まれます。タイムゾーンは親プロパティに基づいています。

フィールド
start_date

Date

必須。この期間の開始日。年、月、日が設定された有効な日付を指定する必要があります。過去、現在、未来の日付を指定できます。

end_date

Date

必須。この期間の終了日。年、月、日が設定された有効な日付を指定する必要があります。この日付は、開始日以降にする必要があります。

RunAccessReportRequest

データアクセス レコード レポートのリクエスト。

フィールド
entity

string

データアクセス レポートは、プロパティ単位またはアカウント単位でのリクエストに対応しています。アカウント単位でリクエストされた場合、データ アクセス レポートには、そのアカウントのすべてのプロパティに対するすべてのアクセスが含まれます。

プロパティ単位でリクエストする場合、エンティティは「properties/123」のようにします(「123」は Google アナリティクスのプロパティ ID です)。アカウント単位でリクエストする場合、エンティティは「accounts/1234」のように指定します(「1234」は Google アナリティクス アカウント ID です)。

dimensions[]

AccessDimension

リクエストされ、レスポンスに表示されるディメンション。リクエストで指定できるディメンションは最大 9 つです。

metrics[]

AccessMetric

リクエストされ、レスポンスに表示される指標。リクエストで指定できる指標は最大 10 個です。

date_ranges[]

AccessDateRange

読み取るアクセス レコードの期間。複数の期間をリクエストした場合、各レスポンス行にはゼロベースの期間インデックスが含まれます。2 つの期間が重複する場合、重複する日付のアクセス レコードは、両方の期間のレスポンス行に含まれます。リクエストで指定できる期間は最大 2 つです。

dimension_filter

AccessFilterExpression

ディメンション フィルタを使用すると、フィルタに一致する特定のディメンション値にレポートのレスポンスを制限できます。たとえば、単一ユーザーのアクセス レコードでフィルタできます。詳細については、ディメンション フィルタの基本で例をご覧ください。このフィルタでは指標を使用できません。

metric_filter

AccessFilterExpression

指標フィルタを使用すると、フィルタに一致する特定の指標値にレポートのレスポンスを制限できます。指標フィルタは、SQL の having 句と同様に、レポートの行の集計後に適用されます。このフィルタではディメンションを使用できません。

offset

int64

開始行の行数。最初の行は行 0 としてカウントされます。オフセットが指定されていない場合、オフセットは 0 として扱われます。オフセットがゼロの場合、このメソッドは limit エントリを含む結果の最初のページを返します。

このページネーション パラメータの詳細については、ページネーションをご覧ください。

limit

int64

返す行数。指定しない場合、10,000 行が返されます。API は、リクエストに応じて最大 100,000 行を返します。limit には正の値を指定してください。

limit と同じ数の行が残っていない場合、API はリクエストされた limit よりも少ない行を返すことがあります。たとえば、ディメンション country の有効な値は 300 個未満であるため、country のみをレポートする場合、limit をより大きい値に設定しても、300 行を超える行を取得することはできません。

このページネーション パラメータの詳細については、ページネーションをご覧ください。

time_zone

string

このリクエストのタイムゾーン(指定されている場合)。指定しない場合、プロパティのタイムゾーンが使用されます。レポートの開始日と終了日は、リクエストのタイムゾーンに基づいて解釈されます。

IANA タイムゾーン データベース(https://www.iana.org/time-zones))の文字列形式(例:「America/New_York」、「Asia/Tokyo」)。

order_bys[]

AccessOrderBy

レスポンスで行の順序付けを行う方法を指定します。

return_entity_quota

bool

このアナリティクス プロパティの割り当ての現在の状態を返すかどうかを切り替えます。割り当ては AccessQuota で返されます。アカウント単位のリクエストの場合、このフィールドは false にする必要があります。

include_all_users

bool

省略可。API 呼び出しを行ったことが一度もないユーザーをレスポンスに含めるかどうかを決定します。true の場合、API 呼び出しを行ったかどうかにかかわらず、指定されたプロパティまたはアカウントにアクセスできるすべてのユーザーがレスポンスに含まれます。false の場合、API 呼び出しを行ったユーザーのみが含まれます。

expand_groups

bool

省略可。ユーザー グループ内のユーザーを返すかどうかを決定します。このフィールドは、include_all_users が true に設定されている場合にのみ機能します。true の場合、指定されたプロパティまたはアカウントにアクセスできるすべてのユーザーが返されます。false の場合、直接アクセス権を持つユーザーのみが返されます。

RunAccessReportResponse

カスタマイズされたデータアクセス レコード レポートのレスポンス。

フィールド
dimension_headers[]

AccessDimensionHeader

特定のディメンションに対応するレポート内の列のヘッダー。DimensionHeader の数と順序が、行に存在するディメンションと一致している。

metric_headers[]

AccessMetricHeader

特定の指標に対応するレポート内の列のヘッダー。MetricHeader の数と MetricHeader の順序が、行に存在する指標と一致している。

rows[]

AccessRow

レポート内のディメンション値の組み合わせと指標値の行。

row_count

int32

クエリ結果の行の合計数。rowCount は、レスポンスで返される行数、limit リクエスト パラメータ、offset リクエスト パラメータとは独立しています。たとえば、クエリが 175 行を返し、API リクエストに 50 の limit が含まれている場合、レスポンスには 175 の rowCount が含まれますが、行は 50 行のみです。

このページネーション パラメータの詳細については、ページネーションをご覧ください。

quota

AccessQuota

このリクエストを含む、このアナリティクス プロパティの割り当て状態。このフィールドは、アカウント単位のリクエストでは機能しません。

SKAdNetworkConversionValueSchema

iOS ストリームの SKAdNetwork コンバージョン値スキーマ。

フィールド
name

string

出力専用。スキーマのリソース名。これは iOS ストリームの子のみであり、iOS ストリームの下に存在できる子ストリームは 1 つだけです。Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema

postback_window_one

PostbackWindow

必須。最初のポストバック ウィンドウのコンバージョン値の設定。これらの値は、ポストバック ウィンドウ 2 と 3 の値とは異なり、コンバージョン値(数値)が「きめ細かく」含まれています。

このポストバック ウィンドウのコンバージョン値を設定する必要があります。他のウィンドウはオプションであり、設定されていない場合や無効になっている場合は、このウィンドウの設定を継承できます。

postback_window_two

PostbackWindow

2 番目のポストバック ウィンドウのコンバージョン値の設定。

このフィールドは、このポストバック ウィンドウに異なるコンバージョン値を定義する必要がある場合にのみ設定してください。

このポストバック ウィンドウで enable_postback_window_settings が false に設定されている場合、postback_window_one の値が使用されます。

postback_window_three

PostbackWindow

3 番目のポストバック ウィンドウのコンバージョン値の設定。

このフィールドは、このポストバック ウィンドウに異なるコンバージョン値を定義することを選択した場合にのみ設定する必要があります。ウィンドウ 2 を設定せずにウィンドウ 3 を構成できます。ウィンドウ 1 と 2 の設定が設定され、このポストバック ウィンドウの enable_postback_window_settings が false に設定されている場合、スキーマは postback_window_two の設定を継承します。

apply_conversion_values

bool

有効にすると、GA SDK はこのスキーマ定義を使用してコンバージョン値を設定し、このプロパティにリンクされているすべての Google 広告アカウントにスキーマがエクスポートされます。無効にすると、GA SDK はコンバージョン値を自動的に設定せず、スキーマも Google 広告にエクスポートされません。

SearchChangeHistoryEventsRequest

SearchChangeHistoryEvents RPC のリクエスト メッセージ。

フィールド
account

string

必須。変更履歴リソースを返すアカウント リソース。形式: accounts/{account}

例: accounts/100

property

string

省略可。子プロパティのリソース名。設定すると、このプロパティまたはその子リソースに加えられた変更のみが返されます。形式: properties/{propertyId}

例: properties/100

resource_type[]

ChangeHistoryResourceType

省略可。設定すると、これらのタイプの少なくとも 1 つに一致するリソースの変更のみが返されます。

action[]

ActionType

省略可。設定されている場合、これらのアクションのいずれか 1 つ以上と一致する変更のみを返します。

actor_email[]

string

省略可。設定すると、このリスト内のユーザーによって行われた変更のみが返されます。

earliest_change_time

Timestamp

省略可。設定されている場合、この時間以降に行われた変更のみを返します(その時刻を含む)。

latest_change_time

Timestamp

省略可。設定されている場合、この時刻より前(その時刻を含む)に行われた変更のみを返します。

page_size

int32

省略可。返される ChangeHistoryEvent アイテムの最大数。指定されていない場合、最大で 50 個のアイテムが返されます。最大値は 200 です(それ以上の値は最大値に強制変換されます)。

サービスが返すページに、この値で指定したよりも少ないアイテム(ゼロの場合もあります)が含まれることがあります。また、ページがさらに存在することもあります。特定の数のアイテムが必要な場合は、必要な数になるまで page_token を使用して追加のページをリクエストする必要があります。

page_token

string

省略可。前回の SearchChangeHistoryEvents 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。ページネーションを行う場合、SearchChangeHistoryEvents に指定する他のすべてのパラメータは、ページトークンを受け取った呼び出しと一致している必要があります。

SearchChangeHistoryEventsResponse

SearchAccounts RPC のレスポンス メッセージ。

フィールド
change_history_events[]

ChangeHistoryEvent

呼び出し元がアクセスできる結果。

next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ServiceLevel

Google アナリティクスのさまざまなサービスレベル。

列挙型
SERVICE_LEVEL_UNSPECIFIED サービスレベルが指定されていないか、無効です。
GOOGLE_ANALYTICS_STANDARD Google アナリティクスの標準バージョン。
GOOGLE_ANALYTICS_360 Google アナリティクスの有料プレミアム バージョン。

SetAutomatedGa4ConfigurationOptOutRequest

GA4 の自動設定プロセスの無効化ステータスの設定リクエスト。

フィールド
property

string

必須。オプトアウト ステータスを設定する UA プロパティ。このリクエストでは、UA-XXXXXX-YY 形式のトラッキング ID ではなく、内部プロパティ ID を使用します。形式: properties/{internalWebPropertyId} 例: properties/1234

opt_out

bool

設定するステータス。

SetAutomatedGa4ConfigurationOptOutResponse

この型にはフィールドがありません。

GA4 の自動設定プロセスのオプトアウト ステータスを設定するためのレスポンス メッセージ。

SubmitUserDeletionRequest

SubmitUserDeletion RPC のリクエスト メッセージ。

フィールド
name

string

必須。ユーザーの削除を送信するプロパティの名前。

共用体フィールド useruser の削除リクエストを送信できるユーザーは、次のいずれかです。
user_id

string

Google アナリティクスのユーザー ID

client_id

string

Google アナリティクスのクライアント ID

app_instance_id

string

Firebase のアプリケーション インスタンス ID

user_provided_data

string

ハッシュ化されていない、暗号化されていないユーザー提供データ

SubmitUserDeletionResponse

SubmitUserDeletion RPC のレスポンス メッセージ。

フィールド
deletion_request_time

Timestamp

この時点より前のすべての訪問者データが削除される日時を指定します。削除リクエストを受信した時刻に設定されます。

SubpropertyEventFilter

Google アナリティクスのサブプロパティ イベント フィルタを表すリソース メッセージ。

フィールド
name

string

出力専用。形式: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} 例: properties/1234/subpropertyEventFilters/5678

filter_clauses[]

SubpropertyEventFilterClause

必須。順序なしリスト。SubpropertyEventFilter を定義するフィルタ句。すべての句が AND 演算で結合され、サブプロパティに送信されるデータが決まります。

apply_to_property

string

変更不可。このフィルタを使用するサブプロパティのリソース名。

SubpropertyEventFilterClause

フィルタを定義する句。フィルタは、包含型(フィルタ句に一致するイベントをサブプロパティのデータに含める)か除外型(フィルタ句に一致するイベントをサブプロパティのデータから除外する)のいずれかです。

フィールド
filter_clause_type

FilterClauseType

必須。フィルタ句の型。

filter_expression

SubpropertyEventFilterExpression

必須。サブプロパティに送信されるイベントの論理式。

FilterClauseType

これが包含フィルタ句か除外フィルタ句かを指定します。

列挙型
FILTER_CLAUSE_TYPE_UNSPECIFIED フィルタ句のタイプが不明または指定されていません。
INCLUDE フィルタ句が満たされると、イベントがサブプロパティに含まれます。
EXCLUDE フィルタ句が満たされると、イベントはサブプロパティから除外されます。

SubpropertyEventFilterCondition

特定のフィルタ式

フィールド
field_name

string

必須。フィルタ処理されるフィールド。

共用体フィールド one_filter

one_filter は次のいずれかになります。

null_filter

bool

null 値のフィルタ。

string_filter

StringFilter

特定のパターンに一致する文字列タイプのディメンションのフィルタ。

StringFilter

特定のパターンに一致する文字列タイプのディメンションのフィルタ。

フィールド
match_type

MatchType

必須。文字列フィルタのマッチタイプ。

value

string

必須。照合に使用される文字列値。

case_sensitive

bool

省略可。true の場合、文字列値は大文字と小文字が区別されます。false の場合、照合時に大文字と小文字は区別されません。

MatchType

一致を判断するためにフィルタがどのように使用されるか。

列挙型
MATCH_TYPE_UNSPECIFIED 一致タイプが不明または指定されていません。
EXACT 文字列値の完全一致。
BEGINS_WITH 文字列値で始まる。
ENDS_WITH 文字列値で終わる。
CONTAINS 文字列値が含まれます。
FULL_REGEXP 正規表現全体が文字列値と一致する。
PARTIAL_REGEXP 部分的な正規表現が文字列値と一致します。

SubpropertyEventFilterExpression

サブプロパティ イベント フィルタの論理式。

フィールド
共用体フィールド expr。フィルタに適用される式。expr は次のいずれかになります。
or_group

SubpropertyEventFilterExpressionList

OR 演算で結合する式のリスト。not_expression 式または filter_condition 式のみを含める必要があります。

not_expression

SubpropertyEventFilterExpression

NOT 演算(反転、補完)を適用するフィルタ式。フィルタのみを含めることができます。これは、最上位の SubpropertyEventFilterExpression では設定できません。

filter_condition

SubpropertyEventFilterCondition

特定のイベントに一致するフィルタを作成します。これは、最上位の SubpropertyEventFilterExpression では設定できません。

SubpropertyEventFilterExpressionList

サブプロパティ イベント フィルタ式のリスト。

フィールド
filter_expressions[]

SubpropertyEventFilterExpression

必須。順序なしリスト。サブプロパティ イベント フィルタ式のリスト

SubpropertySyncConfig

サブプロパティの同期構成では、通常のプロパティの構成をサブプロパティと同期する方法が制御されます。このリソースは、サブプロパティごとに自動的にプロビジョニングされます。

フィールド
name

string

出力専用。ID。形式: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} 例: properties/1234/subpropertySyncConfigs/5678

apply_to_property

string

出力専用。変更不可。これらの設定が適用されるサブプロパティのリソース名。

custom_dimension_and_metric_sync_mode

SynchronizationMode

必須。サブプロパティのカスタム ディメンション / 指標の同期モードを指定します。

[すべて] に設定すると、カスタム ディメンションとカスタム指標の同期がすぐに有効になります。同期モードが [ALL] に設定されている限り、サブプロパティでカスタム ディメンションまたはカスタム指標のローカル構成は許可されません。

[なし] に設定すると、カスタム ディメンションとカスタム指標の同期は無効になります。カスタム ディメンション / 指標は、サブプロパティで明示的に設定する必要があります。

SynchronizationMode

サブプロパティの同期モード

列挙型
SYNCHRONIZATION_MODE_UNSPECIFIED 同期モードが不明または指定されていません。
NONE エンティティは同期されません。サブプロパティではローカル編集が可能です。
ALL エンティティは親プロパティから同期されます。サブプロパティでのローカル ミューテーションは許可されない(作成 / 更新 / 削除)

UpdateAccessBindingRequest

UpdateAccessBinding RPC のリクエスト メッセージ。

フィールド
access_binding

AccessBinding

必須。更新するアクセス バインディング。

UpdateAccountRequest

UpdateAccount RPC のリクエスト メッセージです。

フィールド
account

Account

必須。更新するアカウント。アカウントの name フィールドは、アカウントを識別するために使用されます。

update_mask

FieldMask

必須。更新するフィールドのリスト。フィールド名はスネークケースで指定する必要があります(例: field_to_update)。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateAttributionSettingsRequest

UpdateAttributionSettings RPC のリクエスト メッセージ

フィールド
attribution_settings

AttributionSettings

必須。更新するアトリビューション設定。name フィールドは、更新する設定を識別するために使用されます。

update_mask

FieldMask

必須。更新するフィールドのリスト。フィールド名はスネークケースで指定する必要があります(例: 「field_to_update」)。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateAudienceRequest

UpdateAudience RPC のリクエスト メッセージ。

フィールド
audience

Audience

必須。更新するオーディエンス。オーディエンスの name フィールドは、更新するオーディエンスを識別するために使用されます。

update_mask

FieldMask

必須。更新するフィールドのリスト。フィールド名はスネークケースで指定する必要があります(例: 「field_to_update」)。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateBigQueryLinkRequest

UpdateBigQueryLink RPC のリクエスト メッセージ。

フィールド
update_mask

FieldMask

必須。更新するフィールドのリスト。フィールド名はスネークケースで指定する必要があります(例: 「field_to_update」)。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateCalculatedMetricRequest

UpdateCalculatedMetric RPC のリクエスト メッセージ。

フィールド
calculated_metric

CalculatedMetric

必須。更新する CalculatedMetric

update_mask

FieldMask

必須。更新するフィールドのリスト。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateChannelGroupRequest

UpdateChannelGroup RPC のリクエスト メッセージ。

フィールド
channel_group

ChannelGroup

必須。更新する ChannelGroup。リソースの name フィールドは、更新する ChannelGroup の識別に使用されます。

update_mask

FieldMask

必須。更新するフィールドのリスト。フィールド名はスネークケースで指定する必要があります(例: 「field_to_update」)。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateConversionEventRequest

UpdateConversionEvent RPC のリクエスト メッセージ

フィールド
conversion_event

ConversionEvent

必須。更新するコンバージョン イベント。name フィールドは、更新する設定を識別するために使用されます。

update_mask

FieldMask

必須。更新するフィールドのリスト。フィールド名はスネークケースで指定する必要があります(例: 「field_to_update」)。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateCustomDimensionRequest

UpdateCustomDimension RPC のリクエスト メッセージ。

フィールド
custom_dimension

CustomDimension

更新するカスタム ディメンション

update_mask

FieldMask

必須。更新するフィールドのリスト。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateCustomMetricRequest

UpdateCustomMetric RPC のリクエスト メッセージ。

フィールド
custom_metric

CustomMetric

更新する CustomMetric

update_mask

FieldMask

必須。更新するフィールドのリスト。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateDataRedactionSettingsRequest

UpdateDataRedactionSettings RPC のリクエスト メッセージ。

フィールド
data_redaction_settings

DataRedactionSettings

必須。更新する設定。name フィールドは、更新する設定を識別するために使用されます。

update_mask

FieldMask

必須。更新するフィールドのリスト。フィールド名はスネークケースで指定する必要があります(例: 「field_to_update」)。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateDataRetentionSettingsRequest

UpdateDataRetentionSettings RPC のリクエスト メッセージ。

フィールド
data_retention_settings

DataRetentionSettings

必須。更新する設定。name フィールドは、更新する設定を識別するために使用されます。

update_mask

FieldMask

必須。更新するフィールドのリスト。フィールド名はスネークケースで指定する必要があります(例: 「field_to_update」)。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateDataStreamRequest

UpdateDataStream RPC のリクエスト メッセージ。

フィールド
data_stream

DataStream

更新する DataStream

update_mask

FieldMask

必須。更新するフィールドのリスト。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateDisplayVideo360AdvertiserLinkRequest

UpdateDisplayVideo360AdvertiserLink RPC のリクエスト メッセージ。

フィールド
update_mask

FieldMask

必須。更新するフィールドのリスト。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateEnhancedMeasurementSettingsRequest

UpdateEnhancedMeasurementSettings RPC のリクエスト メッセージ。

フィールド
enhanced_measurement_settings

EnhancedMeasurementSettings

必須。更新する設定。name フィールドは、更新する設定を識別するために使用されます。

update_mask

FieldMask

必須。更新するフィールドのリスト。フィールド名はスネークケースで指定する必要があります(例: 「field_to_update」)。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateEventCreateRuleRequest

UpdateEventCreateRule RPC のリクエスト メッセージ。

フィールド
event_create_rule

EventCreateRule

必須。更新する EventCreateRule。リソースの name フィールドは、更新する EventCreateRule の識別に使用されます。

update_mask

FieldMask

必須。更新するフィールドのリスト。フィールド名はスネークケースで指定する必要があります(例: 「field_to_update」)。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateEventEditRuleRequest

UpdateEventEditRule RPC のリクエスト メッセージ。

フィールド
event_edit_rule

EventEditRule

必須。更新する EventEditRule。リソースの name フィールドは、更新する EventEditRule を識別するために使用されます。

update_mask

FieldMask

必須。更新するフィールドのリスト。フィールド名はスネークケースで指定する必要があります(例: 「field_to_update」)。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateExpandedDataSetRequest

UpdateExpandedDataSet RPC のリクエスト メッセージ。

フィールド
expanded_data_set

ExpandedDataSet

必須。更新する ExpandedDataSet。リソースの name フィールドは、更新する ExpandedDataSet の識別に使用されます。

update_mask

FieldMask

必須。更新するフィールドのリスト。フィールド名はスネークケースで指定する必要があります(例: 「field_to_update」)。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateGoogleAdsLinkRequest

UpdateGoogleAdsLink RPC のリクエスト メッセージ

フィールド
update_mask

FieldMask

必須。更新するフィールドのリスト。フィールド名はスネークケースで指定する必要があります(例: 「field_to_update」)。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateGoogleSignalsSettingsRequest

UpdateGoogleSignalsSettings RPC のリクエスト メッセージ

フィールド
google_signals_settings

GoogleSignalsSettings

必須。更新する設定。name フィールドは、更新する設定を識別するために使用されます。

update_mask

FieldMask

必須。更新するフィールドのリスト。フィールド名はスネークケースで指定する必要があります(例: 「field_to_update」)。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateKeyEventRequest

UpdateKeyEvent RPC のリクエスト メッセージ

フィールド
key_event

KeyEvent

必須。更新するキーイベント。name フィールドは、更新する設定を識別するために使用されます。

update_mask

FieldMask

必須。更新するフィールドのリスト。フィールド名はスネークケースで指定する必要があります(例: 「field_to_update」)。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateMeasurementProtocolSecretRequest

UpdateMeasurementProtocolSecret RPC のリクエスト メッセージ

フィールド
measurement_protocol_secret

MeasurementProtocolSecret

必須。更新する Measurement Protocol シークレット。

update_mask

FieldMask

必須。更新するフィールドのリスト。省略されたフィールドは更新されません。

UpdatePropertyRequest

UpdateProperty RPC のリクエスト メッセージ。

フィールド
property

Property

必須。更新するプロパティ。プロパティの name フィールドは、更新するプロパティを識別するために使用されます。

update_mask

FieldMask

必須。更新するフィールドのリスト。フィールド名はスネークケースで指定する必要があります(例: 「field_to_update」)。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateReportingDataAnnotationRequest

UpdateReportingDataAnnotation RPC のリクエスト メッセージ。

フィールド
reporting_data_annotation

ReportingDataAnnotation

必須。更新するレポートデータ アノテーション。

update_mask

FieldMask

省略可。更新するフィールドのリスト。フィールド名はスネークケースで指定する必要があります(例: field_to_update)。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateSKAdNetworkConversionValueSchemaRequest

UpdateSKAdNetworkConversionValueSchema RPC のリクエスト メッセージ。

フィールド
skadnetwork_conversion_value_schema

SKAdNetworkConversionValueSchema

必須。更新する SKAdNetwork コンバージョン値スキーマ。

update_mask

FieldMask

必須。更新するフィールドのリスト。省略されたフィールドは更新されません。

UpdateSearchAds360LinkRequest

UpdateSearchAds360Link RPC のリクエスト メッセージ。

フィールド
update_mask

FieldMask

必須。更新するフィールドのリスト。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateSubpropertyEventFilterRequest

UpdateSubpropertyEventFilter RPC のリクエスト メッセージ。

フィールド
subproperty_event_filter

SubpropertyEventFilter

必須。更新するサブプロパティ イベント フィルタ。

update_mask

FieldMask

必須。更新するフィールドのリスト。フィールド名はスネークケースで指定する必要があります(例: field_to_update)。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。

UpdateSubpropertySyncConfigRequest

UpdateSubpropertySyncConfig RPC のリクエスト メッセージ。

フィールド
subproperty_sync_config

SubpropertySyncConfig

必須。更新する SubpropertySyncConfig

update_mask

FieldMask

省略可。更新するフィールドのリスト。フィールド名はスネークケースで指定する必要があります(例: field_to_update)。省略されたフィールドは更新されません。エンティティ全体を置き換えるには、文字列「*」を含む 1 つのパスを使用して、すべてのフィールドを照合します。