Skip to content

Commit 78c7fef

Browse files
yoshi-automationyoshi-automation
committed
feat(analyticsadmin): update the API
#### analyticsadmin:v1alpha The following keys were added: - resources.properties.methods.getReportingIdentitySettings.description - resources.properties.methods.getReportingIdentitySettings.flatPath - resources.properties.methods.getReportingIdentitySettings.httpMethod - resources.properties.methods.getReportingIdentitySettings.id - resources.properties.methods.getReportingIdentitySettings.parameterOrder - resources.properties.methods.getReportingIdentitySettings.parameters.name.description - resources.properties.methods.getReportingIdentitySettings.parameters.name.location - resources.properties.methods.getReportingIdentitySettings.parameters.name.pattern - resources.properties.methods.getReportingIdentitySettings.parameters.name.required - resources.properties.methods.getReportingIdentitySettings.parameters.name.type - resources.properties.methods.getReportingIdentitySettings.path - resources.properties.methods.getReportingIdentitySettings.response.$ref - resources.properties.methods.getReportingIdentitySettings.scopes - schemas.GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource.properties.reportingIdentitySettings.$ref - schemas.GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource.properties.reportingIdentitySettings.description - schemas.GoogleAnalyticsAdminV1alphaReportingIdentitySettings.description - schemas.GoogleAnalyticsAdminV1alphaReportingIdentitySettings.id - schemas.GoogleAnalyticsAdminV1alphaReportingIdentitySettings.properties.name.description - schemas.GoogleAnalyticsAdminV1alphaReportingIdentitySettings.properties.name.readOnly - schemas.GoogleAnalyticsAdminV1alphaReportingIdentitySettings.properties.name.type - schemas.GoogleAnalyticsAdminV1alphaReportingIdentitySettings.properties.reportingIdentity.description - schemas.GoogleAnalyticsAdminV1alphaReportingIdentitySettings.properties.reportingIdentity.enum - schemas.GoogleAnalyticsAdminV1alphaReportingIdentitySettings.properties.reportingIdentity.enumDescriptions - schemas.GoogleAnalyticsAdminV1alphaReportingIdentitySettings.properties.reportingIdentity.type - schemas.GoogleAnalyticsAdminV1alphaReportingIdentitySettings.type The following keys were changed: - schemas.GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest.properties.resourceType.items.enum - schemas.GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest.properties.resourceType.items.enumDescriptions
1 parent b040125 commit 78c7fef

File tree

3 files changed

+237
-4
lines changed

3 files changed

+237
-4
lines changed

‎discovery/analyticsadmin-v1alpha.json

Lines changed: 63 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -907,6 +907,32 @@
907907
"https://www.googleapis.com/auth/analytics.readonly"
908908
]
909909
},
910+
"getReportingIdentitySettings": {
911+
"description": "Returns the singleton data retention settings for this property.",
912+
"flatPath": "v1alpha/properties/{propertiesId}/reportingIdentitySettings",
913+
"httpMethod": "GET",
914+
"id": "analyticsadmin.properties.getReportingIdentitySettings",
915+
"parameterOrder": [
916+
"name"
917+
],
918+
"parameters": {
919+
"name": {
920+
"description": "Required. The name of the settings to lookup. Format: properties/{property}/reportingIdentitySettings Example: \"properties/1000/reportingIdentitySettings\"",
921+
"location": "path",
922+
"pattern": "^properties/[^/]+/reportingIdentitySettings$",
923+
"required": true,
924+
"type": "string"
925+
}
926+
},
927+
"path": "v1alpha/{+name}",
928+
"response": {
929+
"$ref": "GoogleAnalyticsAdminV1alphaReportingIdentitySettings"
930+
},
931+
"scopes": [
932+
"https://www.googleapis.com/auth/analytics.edit",
933+
"https://www.googleapis.com/auth/analytics.readonly"
934+
]
935+
},
910936
"list": {
911937
"description": "Returns child Properties under the specified parent Account. Properties will be excluded if the caller does not have access. Soft-deleted (ie: \"trashed\") properties are excluded by default. Returns an empty list if no relevant properties are found.",
912938
"flatPath": "v1alpha/properties",
@@ -5146,7 +5172,7 @@
51465172
}
51475173
}
51485174
},
5149-
"revision": "20250615",
5175+
"revision": "20250625",
51505176
"rootUrl": "https://analyticsadmin.googleapis.com/",
51515177
"schemas": {
51525178
"GoogleAnalyticsAdminV1alphaAccessBetweenFilter": {
@@ -6534,6 +6560,10 @@
65346560
"$ref": "GoogleAnalyticsAdminV1alphaReportingDataAnnotation",
65356561
"description": "A snapshot of a ReportingDataAnnotation resource in change history."
65366562
},
6563+
"reportingIdentitySettings": {
6564+
"$ref": "GoogleAnalyticsAdminV1alphaReportingIdentitySettings",
6565+
"description": "A snapshot of a ReportingIdentitySettings resource in change history."
6566+
},
65376567
"searchAds360Link": {
65386568
"$ref": "GoogleAnalyticsAdminV1alphaSearchAds360Link",
65396569
"description": "A snapshot of a SearchAds360Link resource in change history."
@@ -8960,6 +8990,34 @@
89608990
},
89618991
"type": "object"
89628992
},
8993+
"GoogleAnalyticsAdminV1alphaReportingIdentitySettings": {
8994+
"description": "A resource containing settings related to reporting identity.",
8995+
"id": "GoogleAnalyticsAdminV1alphaReportingIdentitySettings",
8996+
"properties": {
8997+
"name": {
8998+
"description": "Output only. Identifier. Resource name for this reporting identity settings singleton resource. Format: properties/{property_id}/reportingIdentitySettings Example: \"properties/1234/reportingIdentitySettings\"",
8999+
"readOnly": true,
9000+
"type": "string"
9001+
},
9002+
"reportingIdentity": {
9003+
"description": "The strategy used for identifying user identities in reports.",
9004+
"enum": [
9005+
"IDENTITY_BLENDING_STRATEGY_UNSPECIFIED",
9006+
"BLENDED",
9007+
"OBSERVED",
9008+
"DEVICE_BASED"
9009+
],
9010+
"enumDescriptions": [
9011+
"Unspecified blending strategy.",
9012+
"Blended reporting identity strategy.",
9013+
"Observed reporting identity strategy.",
9014+
"Device-based reporting identity strategy."
9015+
],
9016+
"type": "string"
9017+
}
9018+
},
9019+
"type": "object"
9020+
},
89639021
"GoogleAnalyticsAdminV1alphaRollupPropertySourceLink": {
89649022
"description": "A link that references a source property under the parent rollup property.",
89659023
"id": "GoogleAnalyticsAdminV1alphaRollupPropertySourceLink",
@@ -9232,7 +9290,8 @@
92329290
"KEY_EVENT",
92339291
"CALCULATED_METRIC",
92349292
"REPORTING_DATA_ANNOTATION",
9235-
"SUBPROPERTY_SYNC_CONFIG"
9293+
"SUBPROPERTY_SYNC_CONFIG",
9294+
"REPORTING_IDENTITY_SETTINGS"
92369295
],
92379296
"enumDescriptions": [
92389297
"Resource type unknown or not specified.",
@@ -9263,7 +9322,8 @@
92639322
"KeyEvent resource",
92649323
"CalculatedMetric resource",
92659324
"ReportingDataAnnotation resource",
9266-
"SubpropertySyncConfig resource"
9325+
"SubpropertySyncConfig resource",
9326+
"ReportingIdentitySettings resource"
92679327
],
92689328
"type": "string"
92699329
},

‎src/apis/analyticsadmin/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
"webpack": "webpack"
2929
},
3030
"dependencies": {
31-
"googleapis-common": "^8.0.0"
31+
"googleapis-common": "^8.0.2-rc.0"
3232
},
3333
"devDependencies": {
3434
"@microsoft/api-documenter": "^7.8.10",

‎src/apis/analyticsadmin/v1alpha.ts

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1079,6 +1079,10 @@ export namespace analyticsadmin_v1alpha {
10791079
* A snapshot of a ReportingDataAnnotation resource in change history.
10801080
*/
10811081
reportingDataAnnotation?: Schema$GoogleAnalyticsAdminV1alphaReportingDataAnnotation;
1082+
/**
1083+
* A snapshot of a ReportingIdentitySettings resource in change history.
1084+
*/
1085+
reportingIdentitySettings?: Schema$GoogleAnalyticsAdminV1alphaReportingIdentitySettings;
10821086
/**
10831087
* A snapshot of a SearchAds360Link resource in change history.
10841088
*/
@@ -2717,6 +2721,19 @@ export namespace analyticsadmin_v1alpha {
27172721
*/
27182722
startDate?: Schema$GoogleTypeDate;
27192723
}
2724+
/**
2725+
* A resource containing settings related to reporting identity.
2726+
*/
2727+
export interface Schema$GoogleAnalyticsAdminV1alphaReportingIdentitySettings {
2728+
/**
2729+
* Output only. Identifier. Resource name for this reporting identity settings singleton resource. Format: properties/{property_id\}/reportingIdentitySettings Example: "properties/1234/reportingIdentitySettings"
2730+
*/
2731+
name?: string | null;
2732+
/**
2733+
* The strategy used for identifying user identities in reports.
2734+
*/
2735+
reportingIdentity?: string | null;
2736+
}
27202737
/**
27212738
* A link that references a source property under the parent rollup property.
27222739
*/
@@ -7977,6 +7994,155 @@ export namespace analyticsadmin_v1alpha {
79777994
}
79787995
}
79797996

7997+
/**
7998+
* Returns the singleton data retention settings for this property.
7999+
* @example
8000+
* ```js
8001+
* // Before running the sample:
8002+
* // - Enable the API at:
8003+
* // https://console.developers.google.com/apis/api/analyticsadmin.googleapis.com
8004+
* // - Login into gcloud by running:
8005+
* // ```sh
8006+
* // $ gcloud auth application-default login
8007+
* // ```
8008+
* // - Install the npm module by running:
8009+
* // ```sh
8010+
* // $ npm install googleapis
8011+
* // ```
8012+
*
8013+
* const {google} = require('googleapis');
8014+
* const analyticsadmin = google.analyticsadmin('v1alpha');
8015+
*
8016+
* async function main() {
8017+
* const auth = new google.auth.GoogleAuth({
8018+
* // Scopes can be specified either as an array or as a single, space-delimited string.
8019+
* scopes: [
8020+
* 'https://www.googleapis.com/auth/analytics.edit',
8021+
* 'https://www.googleapis.com/auth/analytics.readonly',
8022+
* ],
8023+
* });
8024+
*
8025+
* // Acquire an auth client, and bind it to all future calls
8026+
* const authClient = await auth.getClient();
8027+
* google.options({auth: authClient});
8028+
*
8029+
* // Do the magic
8030+
* const res = await analyticsadmin.properties.getReportingIdentitySettings({
8031+
* // Required. The name of the settings to lookup. Format: properties/{property\}/reportingIdentitySettings Example: "properties/1000/reportingIdentitySettings"
8032+
* name: 'properties/my-propertie/reportingIdentitySettings',
8033+
* });
8034+
* console.log(res.data);
8035+
*
8036+
* // Example response
8037+
* // {
8038+
* // "name": "my_name",
8039+
* // "reportingIdentity": "my_reportingIdentity"
8040+
* // }
8041+
* }
8042+
*
8043+
* main().catch(e => {
8044+
* console.error(e);
8045+
* throw e;
8046+
* });
8047+
*
8048+
* ```
8049+
*
8050+
* @param params - Parameters for request
8051+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
8052+
* @param callback - Optional callback that handles the response.
8053+
* @returns A promise if used with async/await, or void if used with a callback.
8054+
*/
8055+
getReportingIdentitySettings(
8056+
params: Params$Resource$Properties$Getreportingidentitysettings,
8057+
options: StreamMethodOptions
8058+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
8059+
getReportingIdentitySettings(
8060+
params?: Params$Resource$Properties$Getreportingidentitysettings,
8061+
options?: MethodOptions
8062+
): Promise<
8063+
GaxiosResponseWithHTTP2<Schema$GoogleAnalyticsAdminV1alphaReportingIdentitySettings>
8064+
>;
8065+
getReportingIdentitySettings(
8066+
params: Params$Resource$Properties$Getreportingidentitysettings,
8067+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
8068+
callback: BodyResponseCallback<Readable>
8069+
): void;
8070+
getReportingIdentitySettings(
8071+
params: Params$Resource$Properties$Getreportingidentitysettings,
8072+
options:
8073+
| MethodOptions
8074+
| BodyResponseCallback<Schema$GoogleAnalyticsAdminV1alphaReportingIdentitySettings>,
8075+
callback: BodyResponseCallback<Schema$GoogleAnalyticsAdminV1alphaReportingIdentitySettings>
8076+
): void;
8077+
getReportingIdentitySettings(
8078+
params: Params$Resource$Properties$Getreportingidentitysettings,
8079+
callback: BodyResponseCallback<Schema$GoogleAnalyticsAdminV1alphaReportingIdentitySettings>
8080+
): void;
8081+
getReportingIdentitySettings(
8082+
callback: BodyResponseCallback<Schema$GoogleAnalyticsAdminV1alphaReportingIdentitySettings>
8083+
): void;
8084+
getReportingIdentitySettings(
8085+
paramsOrCallback?:
8086+
| Params$Resource$Properties$Getreportingidentitysettings
8087+
| BodyResponseCallback<Schema$GoogleAnalyticsAdminV1alphaReportingIdentitySettings>
8088+
| BodyResponseCallback<Readable>,
8089+
optionsOrCallback?:
8090+
| MethodOptions
8091+
| StreamMethodOptions
8092+
| BodyResponseCallback<Schema$GoogleAnalyticsAdminV1alphaReportingIdentitySettings>
8093+
| BodyResponseCallback<Readable>,
8094+
callback?:
8095+
| BodyResponseCallback<Schema$GoogleAnalyticsAdminV1alphaReportingIdentitySettings>
8096+
| BodyResponseCallback<Readable>
8097+
):
8098+
| void
8099+
| Promise<
8100+
GaxiosResponseWithHTTP2<Schema$GoogleAnalyticsAdminV1alphaReportingIdentitySettings>
8101+
>
8102+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
8103+
let params = (paramsOrCallback ||
8104+
{}) as Params$Resource$Properties$Getreportingidentitysettings;
8105+
let options = (optionsOrCallback || {}) as MethodOptions;
8106+
8107+
if (typeof paramsOrCallback === 'function') {
8108+
callback = paramsOrCallback;
8109+
params = {} as Params$Resource$Properties$Getreportingidentitysettings;
8110+
options = {};
8111+
}
8112+
8113+
if (typeof optionsOrCallback === 'function') {
8114+
callback = optionsOrCallback;
8115+
options = {};
8116+
}
8117+
8118+
const rootUrl =
8119+
options.rootUrl || 'https://analyticsadmin.googleapis.com/';
8120+
const parameters = {
8121+
options: Object.assign(
8122+
{
8123+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
8124+
method: 'GET',
8125+
apiVersion: '',
8126+
},
8127+
options
8128+
),
8129+
params,
8130+
requiredParams: ['name'],
8131+
pathParams: ['name'],
8132+
context: this.context,
8133+
};
8134+
if (callback) {
8135+
createAPIRequest<Schema$GoogleAnalyticsAdminV1alphaReportingIdentitySettings>(
8136+
parameters,
8137+
callback as BodyResponseCallback<unknown>
8138+
);
8139+
} else {
8140+
return createAPIRequest<Schema$GoogleAnalyticsAdminV1alphaReportingIdentitySettings>(
8141+
parameters
8142+
);
8143+
}
8144+
}
8145+
79808146
/**
79818147
* Returns child Properties under the specified parent Account. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.
79828148
* @example
@@ -9522,6 +9688,13 @@ export namespace analyticsadmin_v1alpha {
95229688
*/
95239689
name?: string;
95249690
}
9691+
export interface Params$Resource$Properties$Getreportingidentitysettings
9692+
extends StandardParameters {
9693+
/**
9694+
* Required. The name of the settings to lookup. Format: properties/{property\}/reportingIdentitySettings Example: "properties/1000/reportingIdentitySettings"
9695+
*/
9696+
name?: string;
9697+
}
95259698
export interface Params$Resource$Properties$List extends StandardParameters {
95269699
/**
95279700
* Required. An expression for filtering the results of the request. Fields eligible for filtering are: `parent:`(The resource name of the parent account/property) or `ancestor:`(The resource name of the parent account) or `firebase_project:`(The id or number of the linked firebase project). Some examples of filters: ``` | 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. | ```

0 commit comments

Comments
 (0)