Skip to content
This repository was archived by the owner on Jan 22, 2024. It is now read-only.

fix!: GetUniversalMetadata method removed from the API, GetMetadata method should be used instead feat: reporting requests now support date ranges longer than one year docs: minor documentation updates #89

Merged
gcf-merge-on-green merged 2 commits into from
Nov 12, 2020
Merged

fix!: GetUniversalMetadata method removed from the API, GetMetadata method should be used instead feat: reporting requests now support date ranges longer than one year docs: minor documentation updates #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d37e4a5
fix!: GetUniversalMetadata method removed from the API, GetMetadata m…
yoshi-automation Nov 12, 2020
3de10df
chore: allow breaking changes
chingor13 Nov 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions google-analytics-data/clirr-ignored-differences.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- see http://www.mojohaus.org/clirr-maven-plugin/examples/ignored-differences.html -->
<differences>
<!-- TODO: remove after 0.5.0 -->
<difference>
<differenceType>7002</differenceType>
<className>com/google/analytics/data/v1alpha/AlphaAnalyticsData*</className>
<method>* getUniversalMetadata*(*)</method>
</difference>
<difference>
<differenceType>7002</differenceType>
<className>com/google/analytics/data/v1alpha/stub/*AlphaAnalyticsData*</className>
<method>* getUniversalMetadata*(*)</method>
</difference>
</differences>
88 changes: 22 additions & 66 deletions ...lytics-data/src/main/java/com/google/analytics/data/v1alpha/AlphaAnalyticsDataClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,59 +322,9 @@ public final BatchRunPivotReportsResponse batchRunPivotReports(
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns metadata for dimensions and metrics available in reporting methods. Used to explore the
* dimensions and metrics. Dimensions and metrics will be mostly added over time, but renames and
* deletions may occur.
*
* <p>This method returns Universal Metadata. Universal Metadata are dimensions and metrics
* applicable to any property such as `country` and `totalUsers`.
*
* <p>Sample code:
*
* <pre><code>
* try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
* GetUniversalMetadataRequest request = GetUniversalMetadataRequest.newBuilder().build();
* UniversalMetadata response = alphaAnalyticsDataClient.getUniversalMetadata(request);
* }
* </code></pre>
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final UniversalMetadata getUniversalMetadata(GetUniversalMetadataRequest request) {
return getUniversalMetadataCallable().call(request);
}

// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns metadata for dimensions and metrics available in reporting methods. Used to explore the
* dimensions and metrics. Dimensions and metrics will be mostly added over time, but renames and
* deletions may occur.
*
* <p>This method returns Universal Metadata. Universal Metadata are dimensions and metrics
* applicable to any property such as `country` and `totalUsers`.
*
* <p>Sample code:
*
* <pre><code>
* try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
* GetUniversalMetadataRequest request = GetUniversalMetadataRequest.newBuilder().build();
* ApiFuture&lt;UniversalMetadata&gt; future = alphaAnalyticsDataClient.getUniversalMetadataCallable().futureCall(request);
* // Do something
* UniversalMetadata response = future.get();
* }
* </code></pre>
*/
public final UnaryCallable<GetUniversalMetadataRequest, UniversalMetadata>
getUniversalMetadataCallable() {
return stub.getUniversalMetadataCallable();
}

// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns metadata for dimensions and metrics available in reporting methods. Used to explore the
* dimensions and metrics. In this method, a Google Analytics 4 (GA4) Property Identifier is
* specified in the request, and the metadata response includes Custom dimensions and metrics as
* well as Universal metadata.
* dimensions and metrics. In this method, a Google Analytics GA4 Property Identifier is specified
* in the request, and the metadata response includes Custom dimensions and metrics as well as
* Universal metadata.
*
* <p>For example if a custom metric with parameter name `levels_unlocked` is registered to a
* property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata
Expand All @@ -390,9 +340,12 @@ public final UniversalMetadata getUniversalMetadata(GetUniversalMetadataRequest
* </code></pre>
*
* @param name Required. The resource name of the metadata to retrieve. This name field is
* specified in the URL path and not URL parameters. Property is a numeric Google Analytics 4
* (GA4) Property identifier.
* specified in the URL path and not URL parameters. Property is a numeric Google Analytics
* GA4 Property identifier. To learn more, see [where to find your Property
* ID](https://developers.google.com/analytics/trusted-testing/analytics-data/property-id).
* <p>Example: properties/1234/metadata
* <p>Set the Property ID to 0 for dimensions and metrics common to all properties. In this
* special mode, this method will not return custom dimensions and metrics.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Metadata getMetadata(MetadataName name) {
Expand All @@ -404,9 +357,9 @@ public final Metadata getMetadata(MetadataName name) {
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns metadata for dimensions and metrics available in reporting methods. Used to explore the
* dimensions and metrics. In this method, a Google Analytics 4 (GA4) Property Identifier is
* specified in the request, and the metadata response includes Custom dimensions and metrics as
* well as Universal metadata.
* dimensions and metrics. In this method, a Google Analytics GA4 Property Identifier is specified
* in the request, and the metadata response includes Custom dimensions and metrics as well as
* Universal metadata.
*
* <p>For example if a custom metric with parameter name `levels_unlocked` is registered to a
* property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata
Expand All @@ -422,9 +375,12 @@ public final Metadata getMetadata(MetadataName name) {
* </code></pre>
*
* @param name Required. The resource name of the metadata to retrieve. This name field is
* specified in the URL path and not URL parameters. Property is a numeric Google Analytics 4
* (GA4) Property identifier.
* specified in the URL path and not URL parameters. Property is a numeric Google Analytics
* GA4 Property identifier. To learn more, see [where to find your Property
* ID](https://developers.google.com/analytics/trusted-testing/analytics-data/property-id).
* <p>Example: properties/1234/metadata
* <p>Set the Property ID to 0 for dimensions and metrics common to all properties. In this
* special mode, this method will not return custom dimensions and metrics.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Metadata getMetadata(String name) {
Expand All @@ -435,9 +391,9 @@ public final Metadata getMetadata(String name) {
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns metadata for dimensions and metrics available in reporting methods. Used to explore the
* dimensions and metrics. In this method, a Google Analytics 4 (GA4) Property Identifier is
* specified in the request, and the metadata response includes Custom dimensions and metrics as
* well as Universal metadata.
* dimensions and metrics. In this method, a Google Analytics GA4 Property Identifier is specified
* in the request, and the metadata response includes Custom dimensions and metrics as well as
* Universal metadata.
*
* <p>For example if a custom metric with parameter name `levels_unlocked` is registered to a
* property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata
Expand Down Expand Up @@ -465,9 +421,9 @@ public final Metadata getMetadata(GetMetadataRequest request) {
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* Returns metadata for dimensions and metrics available in reporting methods. Used to explore the
* dimensions and metrics. In this method, a Google Analytics 4 (GA4) Property Identifier is
* specified in the request, and the metadata response includes Custom dimensions and metrics as
* well as Universal metadata.
* dimensions and metrics. In this method, a Google Analytics GA4 Property Identifier is specified
* in the request, and the metadata response includes Custom dimensions and metrics as well as
* Universal metadata.
*
* <p>For example if a custom metric with parameter name `levels_unlocked` is registered to a
* property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata
Expand Down
12 changes: 0 additions & 12 deletions ...tics-data/src/main/java/com/google/analytics/data/v1alpha/AlphaAnalyticsDataSettings.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,12 +86,6 @@ public UnaryCallSettings<RunPivotReportRequest, RunPivotReportResponse> runPivot
return ((AlphaAnalyticsDataStubSettings) getStubSettings()).batchRunPivotReportsSettings();
}

/** Returns the object with the settings used for calls to getUniversalMetadata. */
public UnaryCallSettings<GetUniversalMetadataRequest, UniversalMetadata>
getUniversalMetadataSettings() {
return ((AlphaAnalyticsDataStubSettings) getStubSettings()).getUniversalMetadataSettings();
}

/** Returns the object with the settings used for calls to getMetadata. */
public UnaryCallSettings<GetMetadataRequest, Metadata> getMetadataSettings() {
return ((AlphaAnalyticsDataStubSettings) getStubSettings()).getMetadataSettings();
Expand Down Expand Up @@ -223,12 +217,6 @@ public UnaryCallSettings.Builder<RunReportRequest, RunReportResponse> runReportS
return getStubSettingsBuilder().batchRunPivotReportsSettings();
}

/** Returns the builder for the settings used for calls to getUniversalMetadata. */
public UnaryCallSettings.Builder<GetUniversalMetadataRequest, UniversalMetadata>
getUniversalMetadataSettings() {
return getStubSettingsBuilder().getUniversalMetadataSettings();
}

/** Returns the builder for the settings used for calls to getMetadata. */
public UnaryCallSettings.Builder<GetMetadataRequest, Metadata> getMetadataSettings() {
return getStubSettingsBuilder().getMetadataSettings();
Expand Down
7 changes: 0 additions & 7 deletions ...ics-data/src/main/java/com/google/analytics/data/v1alpha/stub/AlphaAnalyticsDataStub.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,13 @@
import com.google.analytics.data.v1alpha.BatchRunReportsRequest;
import com.google.analytics.data.v1alpha.BatchRunReportsResponse;
import com.google.analytics.data.v1alpha.GetMetadataRequest;
import com.google.analytics.data.v1alpha.GetUniversalMetadataRequest;
import com.google.analytics.data.v1alpha.Metadata;
import com.google.analytics.data.v1alpha.RunPivotReportRequest;
import com.google.analytics.data.v1alpha.RunPivotReportResponse;
import com.google.analytics.data.v1alpha.RunRealtimeReportRequest;
import com.google.analytics.data.v1alpha.RunRealtimeReportResponse;
import com.google.analytics.data.v1alpha.RunReportRequest;
import com.google.analytics.data.v1alpha.RunReportResponse;
import com.google.analytics.data.v1alpha.UniversalMetadata;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.rpc.UnaryCallable;
Expand Down Expand Up @@ -61,11 +59,6 @@ public UnaryCallable<BatchRunReportsRequest, BatchRunReportsResponse> batchRunRe
throw new UnsupportedOperationException("Not implemented: batchRunPivotReportsCallable()");
}

public UnaryCallable<GetUniversalMetadataRequest, UniversalMetadata>
getUniversalMetadataCallable() {
throw new UnsupportedOperationException("Not implemented: getUniversalMetadataCallable()");
}

public UnaryCallable<GetMetadataRequest, Metadata> getMetadataCallable() {
throw new UnsupportedOperationException("Not implemented: getMetadataCallable()");
}
Expand Down
29 changes: 0 additions & 29 deletions .../src/main/java/com/google/analytics/data/v1alpha/stub/AlphaAnalyticsDataStubSettings.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,13 @@
import com.google.analytics.data.v1alpha.BatchRunReportsRequest;
import com.google.analytics.data.v1alpha.BatchRunReportsResponse;
import com.google.analytics.data.v1alpha.GetMetadataRequest;
import com.google.analytics.data.v1alpha.GetUniversalMetadataRequest;
import com.google.analytics.data.v1alpha.Metadata;
import com.google.analytics.data.v1alpha.RunPivotReportRequest;
import com.google.analytics.data.v1alpha.RunPivotReportResponse;
import com.google.analytics.data.v1alpha.RunRealtimeReportRequest;
import com.google.analytics.data.v1alpha.RunRealtimeReportResponse;
import com.google.analytics.data.v1alpha.RunReportRequest;
import com.google.analytics.data.v1alpha.RunReportResponse;
import com.google.analytics.data.v1alpha.UniversalMetadata;
import com.google.api.core.ApiFunction;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.GaxProperties;
Expand Down Expand Up @@ -101,8 +99,6 @@ public class AlphaAnalyticsDataStubSettings extends StubSettings<AlphaAnalyticsD
batchRunReportsSettings;
private final UnaryCallSettings<BatchRunPivotReportsRequest, BatchRunPivotReportsResponse>
batchRunPivotReportsSettings;
private final UnaryCallSettings<GetUniversalMetadataRequest, UniversalMetadata>
getUniversalMetadataSettings;
private final UnaryCallSettings<GetMetadataRequest, Metadata> getMetadataSettings;
private final UnaryCallSettings<RunRealtimeReportRequest, RunRealtimeReportResponse>
runRealtimeReportSettings;
Expand All @@ -129,12 +125,6 @@ public UnaryCallSettings<RunPivotReportRequest, RunPivotReportResponse> runPivot
return batchRunPivotReportsSettings;
}

/** Returns the object with the settings used for calls to getUniversalMetadata. */
public UnaryCallSettings<GetUniversalMetadataRequest, UniversalMetadata>
getUniversalMetadataSettings() {
return getUniversalMetadataSettings;
}

/** Returns the object with the settings used for calls to getMetadata. */
public UnaryCallSettings<GetMetadataRequest, Metadata> getMetadataSettings() {
return getMetadataSettings;
Expand Down Expand Up @@ -219,7 +209,6 @@ protected AlphaAnalyticsDataStubSettings(Builder settingsBuilder) throws IOExcep
runPivotReportSettings = settingsBuilder.runPivotReportSettings().build();
batchRunReportsSettings = settingsBuilder.batchRunReportsSettings().build();
batchRunPivotReportsSettings = settingsBuilder.batchRunPivotReportsSettings().build();
getUniversalMetadataSettings = settingsBuilder.getUniversalMetadataSettings().build();
getMetadataSettings = settingsBuilder.getMetadataSettings().build();
runRealtimeReportSettings = settingsBuilder.runRealtimeReportSettings().build();
}
Expand All @@ -237,8 +226,6 @@ public static class Builder
private final UnaryCallSettings.Builder<
BatchRunPivotReportsRequest, BatchRunPivotReportsResponse>
batchRunPivotReportsSettings;
private final UnaryCallSettings.Builder<GetUniversalMetadataRequest, UniversalMetadata>
getUniversalMetadataSettings;
private final UnaryCallSettings.Builder<GetMetadataRequest, Metadata> getMetadataSettings;
private final UnaryCallSettings.Builder<RunRealtimeReportRequest, RunRealtimeReportResponse>
runRealtimeReportSettings;
Expand Down Expand Up @@ -302,8 +289,6 @@ protected Builder(ClientContext clientContext) {

batchRunPivotReportsSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();

getUniversalMetadataSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();

getMetadataSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();

runRealtimeReportSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
Expand All @@ -314,7 +299,6 @@ protected Builder(ClientContext clientContext) {
runPivotReportSettings,
batchRunReportsSettings,
batchRunPivotReportsSettings,
getUniversalMetadataSettings,
getMetadataSettings,
runRealtimeReportSettings);

Expand Down Expand Up @@ -352,11 +336,6 @@ private static Builder initDefaults(Builder builder) {
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("no_retry_1_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("no_retry_1_params"));

builder
.getUniversalMetadataSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_1_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_1_params"));

builder
.getMetadataSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_1_codes"))
Expand All @@ -377,7 +356,6 @@ protected Builder(AlphaAnalyticsDataStubSettings settings) {
runPivotReportSettings = settings.runPivotReportSettings.toBuilder();
batchRunReportsSettings = settings.batchRunReportsSettings.toBuilder();
batchRunPivotReportsSettings = settings.batchRunPivotReportsSettings.toBuilder();
getUniversalMetadataSettings = settings.getUniversalMetadataSettings.toBuilder();
getMetadataSettings = settings.getMetadataSettings.toBuilder();
runRealtimeReportSettings = settings.runRealtimeReportSettings.toBuilder();

Expand All @@ -387,7 +365,6 @@ protected Builder(AlphaAnalyticsDataStubSettings settings) {
runPivotReportSettings,
batchRunReportsSettings,
batchRunPivotReportsSettings,
getUniversalMetadataSettings,
getMetadataSettings,
runRealtimeReportSettings);
}
Expand Down Expand Up @@ -431,12 +408,6 @@ public UnaryCallSettings.Builder<RunReportRequest, RunReportResponse> runReportS
return batchRunPivotReportsSettings;
}

/** Returns the builder for the settings used for calls to getUniversalMetadata. */
public UnaryCallSettings.Builder<GetUniversalMetadataRequest, UniversalMetadata>
getUniversalMetadataSettings() {
return getUniversalMetadataSettings;
}

/** Returns the builder for the settings used for calls to getMetadata. */
public UnaryCallSettings.Builder<GetMetadataRequest, Metadata> getMetadataSettings() {
return getMetadataSettings;
Expand Down
Loading