Blame - docs/dyn/analyticsadmin_v1alpha.accounts.html - platform/external/python/google-api-python-client

2021-03-02 11:49:08 -0800

[diff] [blame]

90

<p class="firstline">Lookup for a single Account.</p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

91

92

<code><a href="#getDataSharingSettings">getDataSharingSettings(name, x__xgafv=None)</a></code></p>

93

<p class="firstline">Get data sharing settings on an account. Data sharing settings are singletons.</p>

94

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

95

<code><a href="#list">list(pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

96

<p class="firstline">Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.</p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

97

98

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

99

<p class="firstline">Retrieves the next page of results.</p>

100

101

<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>

102

<p class="firstline">Updates an account.</p>

103

104

<code><a href="#provisionAccountTicket">provisionAccountTicket(body=None, x__xgafv=None)</a></code></p>

105

<p class="firstline">Requests a ticket for creating an account.</p>

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

106

107

<code><a href="#searchChangeHistoryEvents">searchChangeHistoryEvents(account, body=None, x__xgafv=None)</a></code></p>

108

<p class="firstline">Searches through all changes to an account or its children given the specified set of filters.</p>

109

110

<code><a href="#searchChangeHistoryEvents_next">searchChangeHistoryEvents_next(previous_request, previous_response)</a></code></p>

111

<p class="firstline">Retrieves the next page of results.</p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

112

<h3>Method Details</h3>

113

114

<code class="details" id="close">close()</code>

115

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

120

<pre>Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.

121

122

Args:

123

name: string, Required. The name of the Account to soft-delete. Format: accounts/{account} Example: "accounts/100" (required)

124

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

131

132

{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

133

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

138

<pre>Lookup for a single Account.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

139

140

Args:

141

name: string, Required. The name of the account to lookup. Format: accounts/{account} Example: "accounts/100" (required)

142

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

149

150

{ # A resource message representing a Google Analytics account.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

151

"createTime": "A String", # Output only. Time when this account was originally created.

152

"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.

153

"displayName": "A String", # Required. Human-readable display name for this account.

154

"name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

155

"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

156

"updateTime": "A String", # Output only. Time when account payload fields were last updated.

157

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

<code class="details" id="getDataSharingSettings">getDataSharingSettings(name, x__xgafv=None)</code>

162

<pre>Get data sharing settings on an account. Data sharing settings are singletons.

163

164

Args:

165

name: string, Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings" (required)

166

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

173

174

{ # A resource message representing data sharing settings of a Google Analytics account.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

175

"name": "A String", # Output only. Resource name. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"

176

"sharingWithGoogleAnySalesEnabled": True or False, # Allows any of Google sales to access the data in order to suggest configuration changes to improve results.

177

"sharingWithGoogleAssignedSalesEnabled": True or False, # Allows Google sales teams that are assigned to the customer to access the data in order to suggest configuration changes to improve results. Sales team restrictions still apply when enabled.

178

"sharingWithGoogleProductsEnabled": True or False, # Allows Google to use the data to improve other Google products or services.

179

"sharingWithGoogleSupportEnabled": True or False, # Allows Google support to access the data in order to help troubleshoot issues.

180

"sharingWithOthersEnabled": True or False, # Allows Google to share the data anonymously in aggregate form with others.

181

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

185

<code class="details" id="list">list(pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</code>

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

186

<pre>Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

187

188

Args:

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

189

pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

190

pageToken: string, A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

191

showDeleted: boolean, Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

192

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

199

200

{ # Request message for ListAccounts RPC.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

201

"accounts": [ # Results that were accessible to the caller.

202

{ # A resource message representing a Google Analytics account.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

203

"createTime": "A String", # Output only. Time when this account was originally created.

204

"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.

205

"displayName": "A String", # Required. Human-readable display name for this account.

206

"name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

207

"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

208

"updateTime": "A String", # Output only. Time when account payload fields were last updated.

209

},

210

],

211

"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

212

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

217

<pre>Retrieves the next page of results.

218

219

Args:

220

previous_request: The request for the previous page. (required)

221

previous_response: The response from the request for the previous page. (required)

222

223

Returns:

224

A request object that you can call 'execute()' on to request the next

225

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

231

<pre>Updates an account.

232

233

Args:

234

name: string, Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100" (required)

235

body: object, The request body.

236

The object takes the form of:

237

238

{ # A resource message representing a Google Analytics account.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

239

"createTime": "A String", # Output only. Time when this account was originally created.

Yoshi Automation Bot

b6971b0

2020-11-26 17:16:03 -0800

[diff] [blame]

240

"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.

Yoshi Automation Bot

0d561ef

2020-11-25 07:50:41 -0800

[diff] [blame]

241

"displayName": "A String", # Required. Human-readable display name for this account.

Yoshi Automation Bot

0bf565c

2020-12-09 08:56:03 -0800

[diff] [blame]

242

"name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

243

"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.

Yoshi Automation Bot

0bf565c

2020-12-09 08:56:03 -0800

[diff] [blame]

244

"updateTime": "A String", # Output only. Time when account payload fields were last updated.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

245

}

246

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

247

updateMask: string, Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

248

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

255

256

{ # A resource message representing a Google Analytics account.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

257

"createTime": "A String", # Output only. Time when this account was originally created.

258

"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.

259

"displayName": "A String", # Required. Human-readable display name for this account.

260

"name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

261

"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

262

"updateTime": "A String", # Output only. Time when account payload fields were last updated.

263

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

</div>

<code class="details" id="provisionAccountTicket">provisionAccountTicket(body=None, x__xgafv=None)</code>

268

<pre>Requests a ticket for creating an account.

269

270

Args:

271

body: object, The request body.

272

The object takes the form of:

273

274

{ # Request message for ProvisionAccountTicket RPC.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

275

"account": { # A resource message representing a Google Analytics account. # The account to create.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

276

"createTime": "A String", # Output only. Time when this account was originally created.

277

"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.

278

"displayName": "A String", # Required. Human-readable display name for this account.

279

"name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

280

"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

281

"updateTime": "A String", # Output only. Time when account payload fields were last updated.

282

},

283

"redirectUri": "A String", # Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Developers Console as a Redirect URI

284

}

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

285

286

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

293

294

{ # Response message for ProvisionAccountTicket RPC.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

295

"accountTicketId": "A String", # The param to be passed in the ToS link.

296

}</pre>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

297

</div>

298

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

299

300

<code class="details" id="searchChangeHistoryEvents">searchChangeHistoryEvents(account, body=None, x__xgafv=None)</code>

301

<pre>Searches through all changes to an account or its children given the specified set of filters.

302

303

Args:

304

account: string, Required. The account resource for which to return change history resources. (required)

305

body: object, The request body.

306

The object takes the form of:

307

308

{ # Request message for SearchChangeHistoryEvents RPC.

309

"action": [ # Optional. If set, only return changes that match one or more of these types of actions.

310

"A String",

311

],

312

"actorEmail": [ # Optional. If set, only return changes if they are made by a user in this list.

313

"A String",

314

],

315

"earliestChangeTime": "A String", # Optional. If set, only return changes made after this time (inclusive).

316

"latestChangeTime": "A String", # Optional. If set, only return changes made before this time (inclusive).

317

"pageSize": 42, # Optional. The maximum number of ChangeHistoryEvent items to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 items will be returned. The maximum value is 200 (higher values will be coerced to the maximum).

318

"pageToken": "A String", # Optional. A page token, received from a previous `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchChangeHistoryEvents` must match the call that provided the page token.

319

"property": "A String", # Optional. Resource name for a child property. If set, only return changes made to this property or its child resources.

320

"resourceType": [ # Optional. If set, only return changes if they are for a resource that matches at least one of these types.

"A String",

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

332

333

{ # Response message for SearchAccounts RPC.

334

"changeHistoryEvents": [ # Results that were accessible to the caller.

335

{ # A set of changes within a Google Analytics account or its child properties that resulted from the same cause. Common causes would be updates made in the Google Analytics UI, changes from customer support, or automatic Google Analytics system changes.

336

"actorType": "A String", # The type of actor that made this change.

337

"changeTime": "A String", # Time when change was made.

338

"changes": [ # A list of changes made in this change history event that fit the filters specified in SearchChangeHistoryEventsRequest.

339

{ # A description of a change to a single Google Analytics resource.

340

"action": "A String", # The type of action that changed this resource.

341

"resource": "A String", # Resource name of the resource whose changes are described by this entry.

342

"resourceAfterChange": { # A snapshot of a resource as before or after the result of a change in change history. # Resource contents from after the change was made. If this resource was deleted in this change, this field will be missing.

343

"account": { # A resource message representing a Google Analytics account. # A snapshot of an Account resource in change history.

344

"createTime": "A String", # Output only. Time when this account was originally created.

345

"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.

346

"displayName": "A String", # Required. Human-readable display name for this account.

347

"name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"

348

"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.

349

"updateTime": "A String", # Output only. Time when account payload fields were last updated.

350

},

351

"androidAppDataStream": { # A resource message representing a Google Analytics Android app stream. # A snapshot of an AndroidAppDataStream resource in change history.

352

"createTime": "A String", # Output only. Time when this stream was originally created.

353

"displayName": "A String", # Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.

354

"firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.

355

"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: "properties/1000/androidAppDataStreams/2000"

356

"packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"

357

"updateTime": "A String", # Output only. Time when stream payload fields were last updated.

358

},

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

359

"conversionEvent": { # A conversion event in a Google Analytics property. # A snapshot of a ConversionEvent resource in change history.

360

"createTime": "A String", # Output only. Time when this conversion event was created in the property.

361

"eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase'

362

"isDeletable": True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.

363

"name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}

364

},

365

"customDimension": { # A definition for a CustomDimension. # A snapshot of a CustomDimension resource in change history.

366

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.

367

"disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.

368

"displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.

369

"name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}

370

"parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.

371

"scope": "A String", # Required. Immutable. The scope of this dimension.

372

},

373

"customMetric": { # A definition for a custom metric. # A snapshot of a CustomMetric resource in change history.

374

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.

375

"displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.

376

"measurementUnit": "A String", # Required. Immutable. The type for the custom metric's value.

377

"name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}

378

"parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.

379

"scope": "A String", # Required. Immutable. The scope of this custom metric.

380

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

381

"firebaseLink": { # A link between an GA4 property and a Firebase project. # A snapshot of a FirebaseLink resource in change history.

382

"createTime": "A String", # Output only. Time when this FirebaseLink was originally created.

383

"maximumUserAccess": "A String", # Maximum user access to the GA4 property allowed to admins of the linked Firebase project.

384

"name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678

385

"project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'

386

},

387

"googleAdsLink": { # A link between an GA4 property and a Google Ads account. # A snapshot of a GoogleAdsLink resource in change history.

yoshi-code-bot

3fd11cb

2021-04-28 05:44:03 -0700

[diff] [blame]

388

"adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

389

"canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.

390

"createTime": "A String", # Output only. Time when this link was originally created.

391

"customerId": "A String", # Immutable. Google Ads customer ID.

392

"emailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.

393

"name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.

394

"updateTime": "A String", # Output only. Time when this link was last updated.

395

},

yoshi-code-bot

2021-05-20 04:44:03 -0700

[diff] [blame]

396

"googleSignalsSettings": { # Settings values for Google Signals. This is a singleton resource. # A snapshot of a GoogleSignalsSettings resource in change history.

397

"consent": "A String", # Output only. Terms of Service acceptance.

398

"name": "A String", # Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"

399

"state": "A String", # Status of this setting.

400

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

401

"iosAppDataStream": { # A resource message representing a Google Analytics IOS app stream. # A snapshot of an IosAppDataStream resource in change history.

402

"bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"

403

"createTime": "A String", # Output only. Time when this stream was originally created.

404

"displayName": "A String", # Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.

405

"firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.

406

"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: "properties/1000/iosAppDataStreams/2000"

407

"updateTime": "A String", # Output only. Time when stream payload fields were last updated.

408

},

yoshi-code-bot

2021-05-20 04:44:03 -0700

[diff] [blame]

409

"measurementProtocolSecret": { # A secret value used for sending hits to Measurement Protocol. # A snapshot of a MeasurementProtocolSecret resource in change history.

410

"displayName": "A String", # Required. Human-readable display name for this secret.

411

"name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

412

"secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.

413

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

414

"property": { # A resource message representing a Google Analytics GA4 property. # A snapshot of a Property resource in change history.

415

"createTime": "A String", # Output only. Time when the entity was originally created.

416

"currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

417

"deleteTime": "A String", # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

418

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

419

"expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

420

"industryCategory": "A String", # Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK

421

"name": "A String", # Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"

422

"parent": "A String", # Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account} Example: "accounts/100"

423

"timeZone": "A String", # Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"

424

"updateTime": "A String", # Output only. Time when entity payload fields were last updated.

425

},

426

"webDataStream": { # A resource message representing a Google Analytics web stream. # A snapshot of a WebDataStream resource in change history.

427

"createTime": "A String", # Output only. Time when this stream was originally created.

428

"defaultUri": "A String", # Immutable. Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"

429

"displayName": "A String", # Required. Human-readable display name for the Data Stream. The max allowed display name length is 100 UTF-16 code units.

430

"firebaseAppId": "A String", # Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.

431

"measurementId": "A String", # Output only. Analytics "Measurement ID", without the "G-" prefix. Example: "G-1A2BCD345E" would just be "1A2BCD345E"

432

"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: "properties/1000/webDataStreams/2000"

433

"updateTime": "A String", # Output only. Time when stream payload fields were last updated.

434

},

435

},

436

"resourceBeforeChange": { # A snapshot of a resource as before or after the result of a change in change history. # Resource contents from before the change was made. If this resource was created in this change, this field will be missing.

437

"account": { # A resource message representing a Google Analytics account. # A snapshot of an Account resource in change history.

438

"createTime": "A String", # Output only. Time when this account was originally created.

439

"deleted": True or False, # Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.

440

"displayName": "A String", # Required. Human-readable display name for this account.

441

"name": "A String", # Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"

442

"regionCode": "A String", # Country of business. Must be a Unicode CLDR region code.

443

"updateTime": "A String", # Output only. Time when account payload fields were last updated.

444

},

445

"androidAppDataStream": { # A resource message representing a Google Analytics Android app stream. # A snapshot of an AndroidAppDataStream resource in change history.

446

"createTime": "A String", # Output only. Time when this stream was originally created.

447

"displayName": "A String", # Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.

448

"firebaseAppId": "A String", # Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.

449

"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: "properties/1000/androidAppDataStreams/2000"

450

"packageName": "A String", # Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"

451

"updateTime": "A String", # Output only. Time when stream payload fields were last updated.

452

},

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

453

"conversionEvent": { # A conversion event in a Google Analytics property. # A snapshot of a ConversionEvent resource in change history.

454

"createTime": "A String", # Output only. Time when this conversion event was created in the property.

455

"eventName": "A String", # Immutable. The event name for this conversion event. Examples: 'click', 'purchase'

456

"isDeletable": True or False, # Output only. If set, this event can currently be deleted via DeleteConversionEvent.

457

"name": "A String", # Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}

458

},

459

"customDimension": { # A definition for a CustomDimension. # A snapshot of a CustomDimension resource in change history.

460

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.

461

"disallowAdsPersonalization": True or False, # Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization. This is currently only supported by user-scoped custom dimensions.

462

"displayName": "A String", # Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.

463

"name": "A String", # Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}

464

"parameterName": "A String", # Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.

465

"scope": "A String", # Required. Immutable. The scope of this dimension.

466

},

467

"customMetric": { # A definition for a custom metric. # A snapshot of a CustomMetric resource in change history.

468

"description": "A String", # Optional. Description for this custom dimension. Max length of 150 characters.

469

"displayName": "A String", # Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.

470

"measurementUnit": "A String", # Required. Immutable. The type for the custom metric's value.

471

"name": "A String", # Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}

472

"parameterName": "A String", # Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.

473

"scope": "A String", # Required. Immutable. The scope of this custom metric.

474

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

475

"firebaseLink": { # A link between an GA4 property and a Firebase project. # A snapshot of a FirebaseLink resource in change history.

476

"createTime": "A String", # Output only. Time when this FirebaseLink was originally created.

477

"maximumUserAccess": "A String", # Maximum user access to the GA4 property allowed to admins of the linked Firebase project.

478

"name": "A String", # Output only. Example format: properties/1234/firebaseLinks/5678

479

"project": "A String", # Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'

480

},

481

"googleAdsLink": { # A link between an GA4 property and a Google Ads account. # A snapshot of a GoogleAdsLink resource in change history.

yoshi-code-bot

3fd11cb

2021-04-28 05:44:03 -0700

[diff] [blame]

482

"adsPersonalizationEnabled": True or False, # Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

483

"canManageClients": True or False, # Output only. If true, this link is for a Google Ads manager account.

484

"createTime": "A String", # Output only. Time when this link was originally created.

485

"customerId": "A String", # Immutable. Google Ads customer ID.

486

"emailAddress": "A String", # Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved.

487

"name": "A String", # Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.

488

"updateTime": "A String", # Output only. Time when this link was last updated.

489

},

yoshi-code-bot

2021-05-20 04:44:03 -0700

[diff] [blame]

490

"googleSignalsSettings": { # Settings values for Google Signals. This is a singleton resource. # A snapshot of a GoogleSignalsSettings resource in change history.

491

"consent": "A String", # Output only. Terms of Service acceptance.

492

"name": "A String", # Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"

493

"state": "A String", # Status of this setting.

494

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

495

"iosAppDataStream": { # A resource message representing a Google Analytics IOS app stream. # A snapshot of an IosAppDataStream resource in change history.

496

"bundleId": "A String", # Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"

497

"createTime": "A String", # Output only. Time when this stream was originally created.

498

"displayName": "A String", # Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.

499

"firebaseAppId": "A String", # Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.

500

"name": "A String", # Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: "properties/1000/iosAppDataStreams/2000"

501

"updateTime": "A String", # Output only. Time when stream payload fields were last updated.

502

},

yoshi-code-bot

2021-05-20 04:44:03 -0700

[diff] [blame]

503

"measurementProtocolSecret": { # A secret value used for sending hits to Measurement Protocol. # A snapshot of a MeasurementProtocolSecret resource in change history.

504

"displayName": "A String", # Required. Human-readable display name for this secret.

505

"name": "A String", # Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

506

"secretValue": "A String", # Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property.

507

},

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

508

"property": { # A resource message representing a Google Analytics GA4 property. # A snapshot of a Property resource in change history.

509

"createTime": "A String", # Output only. Time when the entity was originally created.

510

"currencyCode": "A String", # The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

511

"deleteTime": "A String", # Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

512

"displayName": "A String", # Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

513

"expireTime": "A String", # Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.

yoshi-code-bot