Skip to content

Upgrade version of Campaign Manager API to v5 #62510

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Crowiant wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Upgrade version of Campaign Manager API to v5 #62510

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 12 additions & 12 deletions ...ders/google/src/airflow/providers/google/marketing_platform/operators/campaign_manager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ class GoogleCampaignManagerDeleteReportOperator(BaseOperator):
:param profile_id: The DFA user profile ID.
:param report_name: The name of the report to delete.
:param report_id: The ID of the report.
:param api_version: The version of the api that will be requested, for example 'v4'.
:param api_version: The version of the api that will be requested, for example 'v5'.
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docstring now uses api_version example 'v5', but the "Check official API docs" URL in the same docstring still points to /rest/v4/.... Please update the referenced URL(s) to v5 (or make the URL version-neutral) to avoid misleading users.

Copilot uses AI. Check for mistakes.
:param gcp_conn_id: The connection ID to use when fetching connection info.
:param impersonation_chain: Optional service account to impersonate using short-term
credentials, or chained list of accounts required to get the access_token
Expand All @@ -78,7 +78,7 @@ def __init__(
profile_id: str,
report_name: str | None = None,
report_id: str | None = None,
api_version: str = "v4",
api_version: str = "v5",
gcp_conn_id: str = "google_cloud_default",
impersonation_chain: str | Sequence[str] | None = None,
**kwargs,
Expand Down Expand Up @@ -135,7 +135,7 @@ class GoogleCampaignManagerDownloadReportOperator(BaseOperator):
:param report_name: The report name to set when uploading the local file.
:param gzip: Option to compress local file or file data for upload
:param chunk_size: File will be downloaded in chunks of this many bytes.
:param api_version: The version of the api that will be requested, for example 'v4'.
:param api_version: The version of the api that will be requested, for example 'v5'.
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docstring now references api_version 'v5', but the linked official docs in this class still point to the v4 REST path (/rest/v4/...). Please update the doc links (or make them version-neutral) so the documentation matches the new default.

Copilot uses AI. Check for mistakes.
:param gcp_conn_id: The connection ID to use when fetching connection info.
:param impersonation_chain: Optional service account to impersonate using short-term
credentials, or chained list of accounts required to get the access_token
Expand Down Expand Up @@ -169,7 +169,7 @@ def __init__(
report_name: str | None = None,
gzip: bool = True,
chunk_size: int = 10 * 1024 * 1024,
api_version: str = "v4",
api_version: str = "v5",
gcp_conn_id: str = "google_cloud_default",
impersonation_chain: str | Sequence[str] | None = None,
**kwargs,
Expand Down Expand Up @@ -254,7 +254,7 @@ class GoogleCampaignManagerInsertReportOperator(BaseOperator):

:param profile_id: The DFA user profile ID.
:param report: Report to be created.
:param api_version: The version of the api that will be requested, for example 'v4'.
:param api_version: The version of the api that will be requested, for example 'v5'.
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docstring was updated to use api_version example 'v5', but this class still links to v4 REST docs (/rest/v4/...) above. Please update those URLs to v5 (or a versionless page) to keep documentation consistent with the default behavior.

Copilot uses AI. Check for mistakes.
:param gcp_conn_id: The connection ID to use when fetching connection info.
:param impersonation_chain: Optional service account to impersonate using short-term
credentials, or chained list of accounts required to get the access_token
Expand All @@ -281,7 +281,7 @@ def __init__(
*,
profile_id: str,
report: dict[str, Any],
api_version: str = "v4",
api_version: str = "v5",
gcp_conn_id: str = "google_cloud_default",
impersonation_chain: str | Sequence[str] | None = None,
**kwargs,
Expand Down Expand Up @@ -328,7 +328,7 @@ class GoogleCampaignManagerRunReportOperator(BaseOperator):
:param profile_id: The DFA profile ID.
:param report_id: The ID of the report.
:param synchronous: If set and true, tries to run the report synchronously.
:param api_version: The version of the api that will be requested, for example 'v4'.
:param api_version: The version of the api that will be requested, for example 'v5'.
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This docstring now mentions api_version 'v5', but the referenced official API docs URL for this operator still uses /rest/v4/.... Please update the link(s) to v5 (or a version-neutral reference) to avoid confusion.

Copilot uses AI. Check for mistakes.
:param gcp_conn_id: The connection ID to use when fetching connection info.
:param impersonation_chain: Optional service account to impersonate using short-term
credentials, or chained list of accounts required to get the access_token
Expand All @@ -355,7 +355,7 @@ def __init__(
profile_id: str,
report_id: str,
synchronous: bool = False,
api_version: str = "v4",
api_version: str = "v5",
gcp_conn_id: str = "google_cloud_default",
impersonation_chain: str | Sequence[str] | None = None,
**kwargs,
Expand Down Expand Up @@ -408,7 +408,7 @@ class GoogleCampaignManagerBatchInsertConversionsOperator(BaseOperator):
:param encryption_source: Describes whether the encrypted cookie was received from ad serving
(the %m macro) or from Data Transfer.
:param max_failed_inserts: The maximum number of conversions that failed to be inserted
:param api_version: The version of the api that will be requested, for example 'v4'.
:param api_version: The version of the api that will be requested, for example 'v5'.
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docstring now documents api_version example 'v5', but it still references v4 REST docs for conversions (/rest/v4/...). Please update the linked docs URLs to v5 (or a version-neutral page) so the guidance matches the operator defaults.

Copilot uses AI. Check for mistakes.
:param gcp_conn_id: The connection ID to use when fetching connection info.
:param impersonation_chain: Optional service account to impersonate using short-term
credentials, or chained list of accounts required to get the access_token
Expand Down Expand Up @@ -438,7 +438,7 @@ def __init__(
encryption_entity_id: int,
encryption_source: str,
max_failed_inserts: int = 0,
api_version: str = "v4",
api_version: str = "v5",
gcp_conn_id: str = "google_cloud_default",
impersonation_chain: str | Sequence[str] | None = None,
**kwargs,
Expand Down Expand Up @@ -493,7 +493,7 @@ class GoogleCampaignManagerBatchUpdateConversionsOperator(BaseOperator):
:param encryption_source: Describes whether the encrypted cookie was received from ad serving
(the %m macro) or from Data Transfer.
:param max_failed_updates: The maximum number of conversions that failed to be updated
:param api_version: The version of the api that will be requested, for example 'v4'.
:param api_version: The version of the api that will be requested, for example 'v5'.
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This docstring now documents api_version example 'v5', but the linked conversions documentation URLs still point at v4 (/rest/v4/...). Please update those URLs to v5 (or a version-neutral page) to keep documentation accurate.

Copilot uses AI. Check for mistakes.
:param gcp_conn_id: The connection ID to use when fetching connection info.
:param impersonation_chain: Optional service account to impersonate using short-term
credentials, or chained list of accounts required to get the access_token
Expand Down Expand Up @@ -523,7 +523,7 @@ def __init__(
encryption_entity_id: int,
encryption_source: str,
max_failed_updates: int = 0,
api_version: str = "v4",
api_version: str = "v5",
gcp_conn_id: str = "google_cloud_default",
impersonation_chain: str | Sequence[str] | None = None,
**kwargs,
Expand Down
2 changes: 1 addition & 1 deletion providers/google/tests/unit/google/marketing_platform/operators/test_campaign_manager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@

from tests_common.test_utils.taskinstance import run_task_instance

API_VERSION = "v4"
API_VERSION = "v5"
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These tests always pass api_version explicitly, so they don't verify that the operators' default api_version was changed to v5. Please add at least one test case that omits api_version and asserts the hook is instantiated with v5 by default.

Copilot uses AI. Check for mistakes.
GCP_CONN_ID = "google_cloud_default"

CONVERSION = {
Expand Down