Package google.analytics.admin.v1beta

インデックス

AnalyticsAdminService

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

AcknowledgeUserDataCollection

rpc AcknowledgeUserDataCollection(AcknowledgeUserDataCollectionRequest) returns (AcknowledgeUserDataCollectionResponse)

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

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

認可スコープ

次の 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
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
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
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
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
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
GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

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

認可スコープ

以下のいずれかの 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
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
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
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
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)

プロパティのカスタム ディメンションを一覧表示します。

認可スコープ

以下のいずれかの 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
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
ProvisionAccountTicket

rpc ProvisionAccountTicket(ProvisionAccountTicketRequest) returns (ProvisionAccountTicketResponse)

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

認可スコープ

次の 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
UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

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

認可スコープ

次の 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
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
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

AccessBetweenFilter

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

フィールド
from_value

NumericValue

この番号で始まります。
to_value

NumericValue

この番号で終わる。

AccessDateRange

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

フィールド
start_date

string

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

string

クエリの終了日（YYYY-MM-DD 形式）。指定した日も期間に含みます。startDate より前の日付は指定できません。形式 NdaysAgo、yesterday、today も使用できます。この場合、日付はリクエストのタイムゾーンの現在の時刻に基づいて推測されます。

AccessDimension

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

フィールド
dimension_name

string

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

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

AccessDimensionHeader

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

フィールド
dimension_name

string

ディメンション名（例: userEmail）。

AccessDimensionValue

ディメンションの値。

フィールド
value

string

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

AccessFilter

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

フィールド
field_name

string

ディメンション名または指標名。
共用体フィールド one_filter。Filter に 1 種類のフィルタを指定します。one_filter は次のいずれかになります。
string_filter

AccessStringFilter

文字列関連のフィルタ。
in_list_filter

AccessInListFilter

リスト内の値のフィルタ。
numeric_filter

AccessNumericFilter

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

AccessBetweenFilter

2 つの値のフィルタ。

AccessFilterExpression

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

フィールド
共用体フィールド one_expression。FilterExpression に 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 でサポートされている指標の一覧については、データアクセス スキーマをご覧ください。

指標は metricFilter と orderBys で名前で参照されます。

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_by。OrderBy に 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 アナリティクス サポートチームのスタッフが行った変更。

ArchiveCustomDimensionRequest

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

フィールド
name

string

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

ArchiveCustomMetricRequest

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

フィールド
name

string

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

ChangeHistoryChange

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

フィールド
resource

string

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

ActionType

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

ChangeHistoryResource

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

ChangeHistoryResource

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

ChangeHistoryResource

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

フィールド

共用体フィールド resource。

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

Account

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

Property

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

ConversionEvent

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

MeasurementProtocolSecret

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

DataRetentionSettings

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

DataStream

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

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 リソース

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 をご覧ください。

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。

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

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

CustomDimension

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 指標は収益データをレポートします。

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」

DeleteAccountRequest

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

フィールド
name

string

必須。ソフト削除するアカウントの名前。形式: accounts/{account} 例: accounts/100

DeleteConversionEventRequest

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

フィールド
name

string

必須。削除するコンバージョン イベントのリソース名。形式: properties/{property}/conversionEvents/{conversion_event} 例: "properties/123/conversionEvents/456"

DeleteDataStreamRequest

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

フィールド
name

string

必須。削除する DataStream の名前。形式の例: properties/1234/dataStreams/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"

GetAccountRequest

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

フィールド
name

string

必須。検索するアカウントの名前。形式: accounts/{account} 例: accounts/100

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

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

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"

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 をご覧ください。

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 として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

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 として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

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 として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

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 値

プロパティ

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

利用規約のリンクで渡されるパラメータ。

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

このリクエストを含む、このアナリティクス プロパティの割り当て状態。このフィールドは、アカウント単位のリクエストでは機能しません。

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 アナリティクスの有料プレミアム バージョン。

UpdateAccountRequest

UpdateAccount RPC のリクエスト メッセージです。

フィールド
account

Account

必須。更新するアカウント。アカウントの name フィールドは、アカウントを識別するために使用されます。
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 つのパスを使用して、すべてのフィールドを照合します。

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 つのパスを使用して、すべてのフィールドを照合します。

UpdateGoogleAdsLinkRequest

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

フィールド
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 つのパスを使用して、すべてのフィールドを照合します。