Skip to content

Commit 6729854

Browse files
jradcliffjradcliff
authored
Merge pull request #13 from googleanalytics/keyevents
Update remaining references from 'conversions' to 'keyEvents'
2 parents 1170b82 + 2d6d07a commit 6729854

14 files changed

Lines changed: 85 additions & 93 deletions

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ nox -s lint blacken
6969
export GA_TEST_ACCOUNT_ID=
7070
export GA_TEST_WEB_DATA_STREAM_ID=
7171
export GA_TEST_WEB_DATA_SECRET_ID=
72-
export GA_TEST_CONVERSION_EVENT_ID=
72+
export GA_TEST_KEY_EVENT_ID=
7373
export GA_TEST_ACCOUNT_ACCESS_BINDING_ID=
7474
export GA_TEST_PROPERTY_ACCESS_BINDING_ID=
7575
```

‎google-analytics-admin/accounts_search_change_history_events.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
See https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents
2121
for more information.
2222
"""
23-
# [START analyticsadmin_properties_conversion_events_create]
23+
# [START analyticsadmin_properties_key_events_create]
2424
from datetime import datetime, timedelta
2525

2626
from google.analytics.admin import (
@@ -107,8 +107,8 @@ def print_resource(resource):
107107
print(" DisplayVideo360AdvertiserLink resource")
108108
elif resource.display_video_360_advertiser_link_proposal:
109109
print(" DisplayVideo360AdvertiserLinkProposal resource")
110-
elif resource.conversion_event:
111-
print(" ConversionEvent resource")
110+
elif resource.key_event:
111+
print(" KeyEvent resource")
112112
elif resource.measurement_protocol_secret:
113113
print(" MeasurementProtocolSecret resource")
114114
elif resource.custom_dimension:
@@ -123,7 +123,7 @@ def print_resource(resource):
123123
print()
124124

125125

126-
# [END analyticsadmin_properties_conversion_events_create]
126+
# [END analyticsadmin_properties_key_events_create]
127127

128128
if __name__ == "__main__":
129129
run_sample()

‎google-analytics-admin/noxfile_config.py‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,6 @@
3434
"GA_TEST_WEB_DATA_SECRET_ID": os.getenv(
3535
"GA_TEST_WEB_DATA_SECRET_ID", "2994983412"
3636
),
37-
"GA_TEST_CONVERSION_EVENT_ID": os.getenv(
38-
"GA_TEST_CONVERSION_EVENT_ID", "2719963095"
39-
),
37+
"GA_TEST_KEY_EVENT_ID": os.getenv("GA_TEST_KEY_EVENT_ID", "2719963095"),
4038
},
4139
}

google-analytics-admin/properties_conversion_events_create.py renamed to google-analytics-admin/properties_key_events_create.py

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@
1414
# See the License for the specific language governing permissions and
1515
# limitations under the License.
1616

17-
"""Google Analytics Admin API sample application which creates a conversion
17+
"""Google Analytics Admin API sample application which creates a key
1818
event for the Google Analytics 4 property.
1919
20-
See https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.conversionEvents/create
20+
See https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents/create
2121
for more information.
2222
"""
23-
# [START analyticsadmin_properties_conversion_events_create]
23+
# [START analyticsadmin_properties_key_events_create]
2424
from google.analytics.admin import AnalyticsAdminServiceClient
25-
from google.analytics.admin_v1alpha import ConversionEvent
25+
from google.analytics.admin_v1alpha import KeyEvent
2626

2727

2828
def run_sample():
@@ -37,33 +37,33 @@ def run_sample():
3737
# property ID (e.g. "123456") before running the sample.
3838
property_id = "YOUR-GA4-PROPERTY-ID"
3939

40-
create_conversion_event(property_id)
40+
create_key_event(property_id)
4141

4242

43-
def create_conversion_event(property_id: str, transport: str = None):
43+
def create_key_event(property_id: str, transport: str = None):
4444
"""
45-
Creates a conversion event for the Google Analytics 4 property.
45+
Creates a key event for the Google Analytics 4 property.
4646
4747
Args:
4848
property_id(str): The Google Analytics Property ID.
4949
transport(str): The transport to use. For example, "grpc"
5050
or "rest". If set to None, a transport is chosen automatically.
5151
"""
5252
client = AnalyticsAdminServiceClient(transport=transport)
53-
conversion_event = client.create_conversion_event(
53+
key_event = client.create_key_event(
5454
parent=f"properties/{property_id}",
55-
conversion_event=ConversionEvent(event_name="test_purchase"),
55+
key_event=KeyEvent(event_name="test_purchase"),
5656
)
5757

5858
print("Result:")
59-
print(f"Resource name: {conversion_event.name}")
60-
print(f"Event name: {conversion_event.event_name}")
61-
print(f"Create time: {conversion_event.create_time}")
62-
print(f"Deletable: {conversion_event.deletable}")
63-
print(f"Custom: {conversion_event.custom}")
59+
print(f"Resource name: {key_event.name}")
60+
print(f"Event name: {key_event.event_name}")
61+
print(f"Create time: {key_event.create_time}")
62+
print(f"Deletable: {key_event.deletable}")
63+
print(f"Custom: {key_event.custom}")
6464

6565

66-
# [END analyticsadmin_properties_conversion_events_create]
66+
# [END analyticsadmin_properties_key_events_create]
6767

6868
if __name__ == "__main__":
6969
run_sample()

google-analytics-admin/properties_conversion_events_create_test.py renamed to google-analytics-admin/properties_key_events_create_test.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@
1414

1515
import pytest
1616

17-
import properties_conversion_events_create
17+
import properties_key_events_create
1818

1919
FAKE_PROPERTY_ID = "1"
2020

2121

22-
def test_properties_conversion_events_create():
22+
def test_properties_key_events_create():
2323
transports = ["grpc", "rest"]
2424
for transport in transports:
2525
# This test ensures that the call is valid and reaches the server, even
2626
# though the operation does not succeed due to permission error.
2727
with pytest.raises(Exception, match="The caller does not have permission"):
28-
properties_conversion_events_create.create_conversion_event(
28+
properties_key_events_create.create_key_event(
2929
FAKE_PROPERTY_ID, transport=transport
3030
)

google-analytics-admin/properties_conversion_events_delete.py renamed to google-analytics-admin/properties_key_events_delete.py

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@
1414
# See the License for the specific language governing permissions and
1515
# limitations under the License.
1616

17-
"""Google Analytics Admin API sample application which deletes a conversion
17+
"""Google Analytics Admin API sample application which deletes a key
1818
event for the Google Analytics 4 property.
1919
2020
21-
See https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.conversionEvents/delete
21+
See https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents/delete
2222
for more information.
2323
"""
24-
# [START analyticsadmin_properties_conversion_events_delete]
24+
# [START analyticsadmin_properties_key_events_delete]
2525
from google.analytics.admin import AnalyticsAdminServiceClient
2626

2727

@@ -37,33 +37,29 @@ def run_sample():
3737
# property ID (e.g. "123456") before running the sample.
3838
property_id = "YOUR-GA4-PROPERTY-ID"
3939

40-
# TODO(developer): Replace this variable with your conversion event ID
40+
# TODO(developer): Replace this variable with your key event ID
4141
# (e.g. "123456") before running the sample.
42-
conversion_event_id = "YOUR-CONVERSION-EVENT-ID"
42+
key_event_id = "YOUR-KEY-EVENT-ID"
4343

44-
delete_conversion_event(property_id, conversion_event_id)
44+
delete_key_event(property_id, key_event_id)
4545

4646

47-
def delete_conversion_event(
48-
property_id: str, conversion_event_id: str, transport: str = None
49-
):
47+
def delete_key_event(property_id: str, key_event_id: str, transport: str = None):
5048
"""
51-
Deletes the conversion event for the Google Analytics 4 property.
49+
Deletes the key event for the Google Analytics 4 property.
5250
5351
Args:
5452
property_id(str): The Google Analytics Property ID.
55-
conversion_event_id(str): The conversion event ID
53+
key_event_id(str): The key event ID
5654
transport(str): The transport to use. For example, "grpc"
5755
or "rest". If set to None, a transport is chosen automatically.
5856
"""
5957
client = AnalyticsAdminServiceClient(transport=transport)
60-
client.delete_conversion_event(
61-
name=f"properties/{property_id}/conversionEvents/{conversion_event_id}"
62-
)
63-
print("Conversion event deleted")
58+
client.delete_key_event(name=f"properties/{property_id}/keyEvents/{key_event_id}")
59+
print("Key event deleted")
6460

6561

66-
# [END analyticsadmin_properties_conversion_events_delete]
62+
# [END analyticsadmin_properties_key_events_delete]
6763

6864

6965
if __name__ == "__main__":

google-analytics-admin/properties_conversion_events_delete_test.py renamed to google-analytics-admin/properties_key_events_delete_test.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,18 @@
1414

1515
import pytest
1616

17-
import properties_conversion_events_delete
17+
import properties_key_events_delete
1818

1919
FAKE_PROPERTY_ID = "1"
20-
FAKE_CONVERSION_EVENT_ID = "1"
20+
FAKE_KEY_EVENT_ID = "1"
2121

2222

23-
def test_properties_conversion_events_delete():
23+
def test_properties_key_events_delete():
2424
transports = ["grpc", "rest"]
2525
for transport in transports:
2626
# This test ensures that the call is valid and reaches the server, even
2727
# though the operation does not succeed due to permission error.
2828
with pytest.raises(Exception, match="The caller does not have permission"):
29-
properties_conversion_events_delete.delete_conversion_event(
30-
FAKE_PROPERTY_ID, FAKE_CONVERSION_EVENT_ID, transport=transport
29+
properties_key_events_delete.delete_key_event(
30+
FAKE_PROPERTY_ID, FAKE_KEY_EVENT_ID, transport=transport
3131
)

google-analytics-admin/properties_conversion_events_get.py renamed to google-analytics-admin/properties_key_events_get.py

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@
1414
# See the License for the specific language governing permissions and
1515
# limitations under the License.
1616

17-
"""Google Analytics Admin API sample application which prints the conversion
17+
"""Google Analytics Admin API sample application which prints the key
1818
event details.
1919
20-
See https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.conversionEvents/get
20+
See https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents/get
2121
for more information.
2222
"""
23-
# [START analyticsadmin_properties_conversion_events_get]
23+
# [START analyticsadmin_properties_key_events_get]
2424
from google.analytics.admin import AnalyticsAdminServiceClient
2525

2626

@@ -30,38 +30,36 @@ def run_sample():
3030
# property ID (e.g. "123456") before running the sample.
3131
property_id = "YOUR-GA4-PROPERTY-ID"
3232

33-
# TODO(developer): Replace this variable with your conversion event ID
33+
# TODO(developer): Replace this variable with your key event ID
3434
# (e.g. "123456") before running the sample.
35-
conversion_event_id = "YOUR-CONVERSION-EVENT-ID"
35+
key_event_id = "YOUR-KEY-EVENT-ID"
3636

37-
get_conversion_event(property_id, conversion_event_id)
37+
get_key_event(property_id, key_event_id)
3838

3939

40-
def get_conversion_event(
41-
property_id: str, conversion_event_id: str, transport: str = None
42-
):
40+
def get_key_event(property_id: str, key_event_id: str, transport: str = None):
4341
"""
44-
Retrieves the details for the conversion event.
42+
Retrieves the details for the key event.
4543
Args:
4644
property_id(str): The Google Analytics Property ID.
47-
conversion_event_id(str): The conversion event ID
45+
key_event_id(str): The key event ID
4846
transport(str): The transport to use. For example, "grpc"
4947
or "rest". If set to None, a transport is chosen automatically.
5048
"""
5149
client = AnalyticsAdminServiceClient(transport=transport)
52-
conversion_event = client.get_conversion_event(
53-
name=f"properties/{property_id}/conversionEvents/{conversion_event_id}"
50+
key_event = client.get_key_event(
51+
name=f"properties/{property_id}/keyEvents/{key_event_id}"
5452
)
5553

5654
print("Result:")
57-
print(f"Resource name: {conversion_event.name}")
58-
print(f"Event name: {conversion_event.event_name}")
59-
print(f"Create time: {conversion_event.create_time}")
60-
print(f"Deletable: {conversion_event.deletable}")
61-
print(f"Custom: {conversion_event.custom}")
55+
print(f"Resource name: {key_event.name}")
56+
print(f"Event name: {key_event.event_name}")
57+
print(f"Create time: {key_event.create_time}")
58+
print(f"Deletable: {key_event.deletable}")
59+
print(f"Custom: {key_event.custom}")
6260

6361

64-
# [END analyticsadmin_properties_conversion_events_get]
62+
# [END analyticsadmin_properties_key_events_get]
6563

6664

6765
if __name__ == "__main__":

google-analytics-admin/properties_conversion_events_get_test.py renamed to google-analytics-admin/properties_key_events_get_test.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@
1414

1515
import os
1616

17-
import properties_conversion_events_get
17+
import properties_key_events_get
1818

1919
TEST_PROPERTY_ID = os.getenv("GA_TEST_PROPERTY_ID")
20-
TEST_CONVERSION_EVENT_ID = os.getenv("GA_TEST_CONVERSION_EVENT_ID")
20+
TEST_KEY_EVENT_ID = os.getenv("GA_TEST_KEY_EVENT_ID")
2121

2222

23-
def test_properties_conversion_events_get(capsys):
23+
def test_properties_key_events_get(capsys):
2424
transports = ["grpc", "rest"]
2525
for transport in transports:
26-
properties_conversion_events_get.get_conversion_event(
27-
TEST_PROPERTY_ID, TEST_CONVERSION_EVENT_ID, transport=transport
26+
properties_key_events_get.get_key_event(
27+
TEST_PROPERTY_ID, TEST_KEY_EVENT_ID, transport=transport
2828
)
2929
out, _ = capsys.readouterr()
3030
assert "Result" in out

google-analytics-admin/properties_conversion_events_list.py renamed to google-analytics-admin/properties_key_events_list.py

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@
1414
# See the License for the specific language governing permissions and
1515
# limitations under the License.
1616

17-
"""Google Analytics Admin API sample application which lists conversion events
17+
"""Google Analytics Admin API sample application which lists key events
1818
for the Google Analytics 4 property.
1919
20-
See https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.conversionEvents/list
20+
See https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/properties.keyEvents/list
2121
for more information.
2222
"""
23-
# [START analyticsadmin_properties_conversion_events_list]
23+
# [START analyticsadmin_properties_key_events_list]
2424
from google.analytics.admin import AnalyticsAdminServiceClient
2525

2626

@@ -30,32 +30,32 @@ def run_sample():
3030
# property ID (e.g. "123456") before running the sample.
3131
property_id = "YOUR-GA4-PROPERTY-ID"
3232

33-
list_conversion_events(property_id)
33+
list_key_events(property_id)
3434

3535

36-
def list_conversion_events(property_id: str, transport: str = None):
36+
def list_key_events(property_id: str, transport: str = None):
3737
"""
38-
Lists conversion events for the Google Analytics 4 property.
38+
Lists key events for the Google Analytics 4 property.
3939
4040
Args:
4141
property_id(str): The Google Analytics Property ID.
4242
transport(str): The transport to use. For example, "grpc"
4343
or "rest". If set to None, a transport is chosen automatically.
4444
"""
4545
client = AnalyticsAdminServiceClient(transport=transport)
46-
results = client.list_conversion_events(parent=f"properties/{property_id}")
46+
results = client.list_key_events(parent=f"properties/{property_id}")
4747

4848
print("Result:")
49-
for conversion_event in results:
50-
print(f"Resource name: {conversion_event.name}")
51-
print(f"Event name: {conversion_event.event_name}")
52-
print(f"Create time: {conversion_event.create_time}")
53-
print(f"Deletable: {conversion_event.deletable}")
54-
print(f"Custom: {conversion_event.custom}")
49+
for key_event in results:
50+
print(f"Resource name: {key_event.name}")
51+
print(f"Event name: {key_event.event_name}")
52+
print(f"Create time: {key_event.create_time}")
53+
print(f"Deletable: {key_event.deletable}")
54+
print(f"Custom: {key_event.custom}")
5555
print()
5656

5757

58-
# [END analyticsadmin_properties_conversion_events_list]
58+
# [END analyticsadmin_properties_key_events_list]
5959

6060

6161
if __name__ == "__main__":

0 commit comments

Comments
 (0)