apache-airflow-providers-google 8.12.0rc1__py3-none-any.whl → 9.0.0rc2__py3-none-any.whl

airflow/providers/google_vendor/googleads/v12/services/types/conversion_adjustment_upload_service.py

@@ -0,0 +1,279 @@
+# -*- coding: utf-8 -*-
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+import proto  # type: ignore
+
+from airflow.providers.google_vendor.googleads.v12.common.types import offline_user_data
+from airflow.providers.google_vendor.googleads.v12.enums.types import conversion_adjustment_type
+from google.rpc import status_pb2  # type: ignore
+
+
+__protobuf__ = proto.module(
+    package="airflow.providers.google_vendor.googleads.v12.services",
+    marshal="google.ads.googleads.v12",
+    manifest={
+        "UploadConversionAdjustmentsRequest",
+        "UploadConversionAdjustmentsResponse",
+        "ConversionAdjustment",
+        "RestatementValue",
+        "GclidDateTimePair",
+        "ConversionAdjustmentResult",
+    },
+)
+
+
+class UploadConversionAdjustmentsRequest(proto.Message):
+    r"""Request message for
+    [ConversionAdjustmentUploadService.UploadConversionAdjustments][google.ads.googleads.v12.services.ConversionAdjustmentUploadService.UploadConversionAdjustments].
+
+    Attributes:
+        customer_id (str):
+            Required. The ID of the customer performing
+            the upload.
+        conversion_adjustments (Sequence[google.ads.googleads.v12.services.types.ConversionAdjustment]):
+            Required. The conversion adjustments that are
+            being uploaded.
+        partial_failure (bool):
+            Required. If true, successful operations will
+            be carried out and invalid operations will
+            return errors. If false, all operations will be
+            carried out in one transaction if and only if
+            they are all valid. This should always be set to
+            true.
+            See
+            https://developers.google.com/google-ads/api/docs/best-practices/partial-failures
+            for more information about partial failure.
+        validate_only (bool):
+            If true, the request is validated but not
+            executed. Only errors are returned, not results.
+    """
+
+    customer_id = proto.Field(proto.STRING, number=1,)
+    conversion_adjustments = proto.RepeatedField(
+        proto.MESSAGE, number=2, message="ConversionAdjustment",
+    )
+    partial_failure = proto.Field(proto.BOOL, number=3,)
+    validate_only = proto.Field(proto.BOOL, number=4,)
+
+
+class UploadConversionAdjustmentsResponse(proto.Message):
+    r"""Response message for
+    [ConversionAdjustmentUploadService.UploadConversionAdjustments][google.ads.googleads.v12.services.ConversionAdjustmentUploadService.UploadConversionAdjustments].
+
+    Attributes:
+        partial_failure_error (google.rpc.status_pb2.Status):
+            Errors that pertain to conversion adjustment
+            failures in the partial failure mode. Returned
+            when all errors occur inside the adjustments. If
+            any errors occur outside the adjustments (for
+            example, auth errors), we return an RPC level
+            error. See
+            https://developers.google.com/google-ads/api/docs/best-practices/partial-failures
+            for more information about partial failure.
+        results (Sequence[google.ads.googleads.v12.services.types.ConversionAdjustmentResult]):
+            Returned for successfully processed conversion adjustments.
+            Proto will be empty for rows that received an error. Results
+            are not returned when validate_only is true.
+    """
+
+    partial_failure_error = proto.Field(
+        proto.MESSAGE, number=1, message=status_pb2.Status,
+    )
+    results = proto.RepeatedField(
+        proto.MESSAGE, number=2, message="ConversionAdjustmentResult",
+    )
+
+
+class ConversionAdjustment(proto.Message):
+    r"""A conversion adjustment.
+
+    Attributes:
+        gclid_date_time_pair (google.ads.googleads.v12.services.types.GclidDateTimePair):
+            For adjustments, uniquely identifies a conversion that was
+            reported without an order ID specified. If the
+            adjustment_type is ENHANCEMENT, this value is optional but
+            may be set in addition to the order_id.
+        order_id (str):
+            The order ID of the conversion to be
+            adjusted. If the conversion was reported with an
+            order ID specified, that order ID must be used
+            as the identifier here. The order ID is required
+            for enhancements.
+
+            This field is a member of `oneof`_ ``_order_id``.
+        conversion_action (str):
+            Resource name of the conversion action
+            associated with this conversion adjustment.
+            Note: Although this resource name consists of a
+            customer id and a conversion action id,
+            validation will ignore the customer id and use
+            the conversion action id as the sole identifier
+            of the conversion action.
+
+            This field is a member of `oneof`_ ``_conversion_action``.
+        adjustment_date_time (str):
+            The date time at which the adjustment occurred. Must be
+            after the conversion_date_time. The timezone must be
+            specified. The format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for
+            example, "2019-01-01 12:32:45-08:00".
+
+            This field is a member of `oneof`_ ``_adjustment_date_time``.
+        adjustment_type (google.ads.googleads.v12.enums.types.ConversionAdjustmentTypeEnum.ConversionAdjustmentType):
+            The adjustment type.
+        restatement_value (google.ads.googleads.v12.services.types.RestatementValue):
+            Information needed to restate the
+            conversion's value. Required for restatements.
+            Should not be supplied for retractions. An error
+            will be returned if provided for a retraction.
+            NOTE: If you want to upload a second restatement
+            with a different adjusted value, it must have a
+            new, more recent, adjustment occurrence time.
+            Otherwise, it will be treated as a duplicate of
+            the previous restatement and ignored.
+        user_identifiers (Sequence[google.ads.googleads.v12.common.types.UserIdentifier]):
+            The user identifiers to enhance the original
+            conversion. ConversionAdjustmentUploadService
+            only accepts user identifiers in enhancements.
+            The maximum number of user identifiers for each
+            enhancement is 5.
+        user_agent (str):
+            The user agent to enhance the original conversion. This can
+            be found in your user's HTTP request header when they
+            convert on your web page. Example, "Mozilla/5.0 (iPhone; CPU
+            iPhone OS 12_2 like Mac OS X)". User agent can only be
+            specified in enhancements with user identifiers. This should
+            match the user agent of the request that sent the original
+            conversion so the conversion and its enhancement are either
+            both attributed as same-device or both attributed as
+            cross-device.
+
+            This field is a member of `oneof`_ ``_user_agent``.
+    """
+
+    gclid_date_time_pair = proto.Field(
+        proto.MESSAGE, number=12, message="GclidDateTimePair",
+    )
+    order_id = proto.Field(proto.STRING, number=13, optional=True,)
+    conversion_action = proto.Field(proto.STRING, number=8, optional=True,)
+    adjustment_date_time = proto.Field(proto.STRING, number=9, optional=True,)
+    adjustment_type = proto.Field(
+        proto.ENUM,
+        number=5,
+        enum=conversion_adjustment_type.ConversionAdjustmentTypeEnum.ConversionAdjustmentType,
+    )
+    restatement_value = proto.Field(
+        proto.MESSAGE, number=6, message="RestatementValue",
+    )
+    user_identifiers = proto.RepeatedField(
+        proto.MESSAGE, number=10, message=offline_user_data.UserIdentifier,
+    )
+    user_agent = proto.Field(proto.STRING, number=11, optional=True,)
+
+
+class RestatementValue(proto.Message):
+    r"""Contains information needed to restate a conversion's value.
+
+    Attributes:
+        adjusted_value (float):
+            The restated conversion value. This is the
+            value of the conversion after restatement. For
+            example, to change the value of a conversion
+            from 100 to 70, an adjusted value of 70 should
+            be reported. NOTE: If you want to upload a
+            second restatement with a different adjusted
+            value, it must have a new, more recent,
+            adjustment occurrence time. Otherwise, it will
+            be treated as a duplicate of the previous
+            restatement and ignored.
+
+            This field is a member of `oneof`_ ``_adjusted_value``.
+        currency_code (str):
+            The currency of the restated value. If not
+            provided, then the default currency from the
+            conversion action is used, and if that is not
+            set then the account currency is used. This is
+            the ISO 4217 3-character currency code for
+            example, USD or EUR.
+
+            This field is a member of `oneof`_ ``_currency_code``.
+    """
+
+    adjusted_value = proto.Field(proto.DOUBLE, number=3, optional=True,)
+    currency_code = proto.Field(proto.STRING, number=4, optional=True,)
+
+
+class GclidDateTimePair(proto.Message):
+    r"""Uniquely identifies a conversion that was reported without an
+    order ID specified.
+
+    Attributes:
+        gclid (str):
+            Google click ID (gclid) associated with the
+            original conversion for this adjustment.
+
+            This field is a member of `oneof`_ ``_gclid``.
+        conversion_date_time (str):
+            The date time at which the original conversion for this
+            adjustment occurred. The timezone must be specified. The
+            format is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example,
+            "2019-01-01 12:32:45-08:00".
+
+            This field is a member of `oneof`_ ``_conversion_date_time``.
+    """
+
+    gclid = proto.Field(proto.STRING, number=3, optional=True,)
+    conversion_date_time = proto.Field(proto.STRING, number=4, optional=True,)
+
+
+class ConversionAdjustmentResult(proto.Message):
+    r"""Information identifying a successfully processed
+    ConversionAdjustment.
+
+    Attributes:
+        gclid_date_time_pair (google.ads.googleads.v12.services.types.GclidDateTimePair):
+            The gclid and conversion date time of the
+            conversion.
+        order_id (str):
+            The order ID of the conversion to be
+            adjusted.
+        conversion_action (str):
+            Resource name of the conversion action
+            associated with this conversion adjustment.
+
+            This field is a member of `oneof`_ ``_conversion_action``.
+        adjustment_date_time (str):
+            The date time at which the adjustment occurred. The format
+            is "yyyy-mm-dd hh:mm:ss+|-hh:mm", for example, "2019-01-01
+            12:32:45-08:00".
+
+            This field is a member of `oneof`_ ``_adjustment_date_time``.
+        adjustment_type (google.ads.googleads.v12.enums.types.ConversionAdjustmentTypeEnum.ConversionAdjustmentType):
+            The adjustment type.
+    """
+
+    gclid_date_time_pair = proto.Field(
+        proto.MESSAGE, number=9, message="GclidDateTimePair",
+    )
+    order_id = proto.Field(proto.STRING, number=10,)
+    conversion_action = proto.Field(proto.STRING, number=7, optional=True,)
+    adjustment_date_time = proto.Field(proto.STRING, number=8, optional=True,)
+    adjustment_type = proto.Field(
+        proto.ENUM,
+        number=5,
+        enum=conversion_adjustment_type.ConversionAdjustmentTypeEnum.ConversionAdjustmentType,
+    )
+
+
+__all__ = tuple(sorted(__protobuf__.manifest))

airflow/providers/google_vendor/googleads/v12/services/types/conversion_custom_variable_service.py

@@ -0,0 +1,167 @@
+# -*- coding: utf-8 -*-
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+import proto  # type: ignore
+
+from airflow.providers.google_vendor.googleads.v12.enums.types import (
+    response_content_type as gage_response_content_type,
+)
+from airflow.providers.google_vendor.googleads.v12.resources.types import (
+    conversion_custom_variable as gagr_conversion_custom_variable,
+)
+from google.protobuf import field_mask_pb2  # type: ignore
+from google.rpc import status_pb2  # type: ignore
+
+
+__protobuf__ = proto.module(
+    package="airflow.providers.google_vendor.googleads.v12.services",
+    marshal="google.ads.googleads.v12",
+    manifest={
+        "MutateConversionCustomVariablesRequest",
+        "ConversionCustomVariableOperation",
+        "MutateConversionCustomVariablesResponse",
+        "MutateConversionCustomVariableResult",
+    },
+)
+
+
+class MutateConversionCustomVariablesRequest(proto.Message):
+    r"""Request message for
+    [ConversionCustomVariableService.MutateConversionCustomVariables][google.ads.googleads.v12.services.ConversionCustomVariableService.MutateConversionCustomVariables].
+
+    Attributes:
+        customer_id (str):
+            Required. The ID of the customer whose
+            conversion custom variables are being modified.
+        operations (Sequence[google.ads.googleads.v12.services.types.ConversionCustomVariableOperation]):
+            Required. The list of operations to perform
+            on individual conversion custom variables.
+        partial_failure (bool):
+            If true, successful operations will be
+            carried out and invalid operations will return
+            errors. If false, all operations will be carried
+            out in one transaction if and only if they are
+            all valid. Default is false.
+        validate_only (bool):
+            If true, the request is validated but not
+            executed. Only errors are returned, not results.
+        response_content_type (google.ads.googleads.v12.enums.types.ResponseContentTypeEnum.ResponseContentType):
+            The response content type setting. Determines
+            whether the mutable resource or just the
+            resource name should be returned post mutation.
+    """
+
+    customer_id = proto.Field(proto.STRING, number=1,)
+    operations = proto.RepeatedField(
+        proto.MESSAGE, number=2, message="ConversionCustomVariableOperation",
+    )
+    partial_failure = proto.Field(proto.BOOL, number=3,)
+    validate_only = proto.Field(proto.BOOL, number=4,)
+    response_content_type = proto.Field(
+        proto.ENUM,
+        number=5,
+        enum=gage_response_content_type.ResponseContentTypeEnum.ResponseContentType,
+    )
+
+
+class ConversionCustomVariableOperation(proto.Message):
+    r"""A single operation (create, update) on a conversion custom
+    variable.
+
+    This message has `oneof`_ fields (mutually exclusive fields).
+    For each oneof, at most one member field can be set at the same time.
+    Setting any member of the oneof automatically clears all other
+    members.
+
+    .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
+
+    Attributes:
+        update_mask (google.protobuf.field_mask_pb2.FieldMask):
+            FieldMask that determines which resource
+            fields are modified in an update.
+        create (google.ads.googleads.v12.resources.types.ConversionCustomVariable):
+            Create operation: No resource name is
+            expected for the new conversion custom variable.
+
+            This field is a member of `oneof`_ ``operation``.
+        update (google.ads.googleads.v12.resources.types.ConversionCustomVariable):
+            Update operation: The conversion custom
+            variable is expected to have a valid resource
+            name.
+
+            This field is a member of `oneof`_ ``operation``.
+    """
+
+    update_mask = proto.Field(
+        proto.MESSAGE, number=3, message=field_mask_pb2.FieldMask,
+    )
+    create = proto.Field(
+        proto.MESSAGE,
+        number=1,
+        oneof="operation",
+        message=gagr_conversion_custom_variable.ConversionCustomVariable,
+    )
+    update = proto.Field(
+        proto.MESSAGE,
+        number=2,
+        oneof="operation",
+        message=gagr_conversion_custom_variable.ConversionCustomVariable,
+    )
+
+
+class MutateConversionCustomVariablesResponse(proto.Message):
+    r"""Response message for
+    [ConversionCustomVariableService.MutateConversionCustomVariables][google.ads.googleads.v12.services.ConversionCustomVariableService.MutateConversionCustomVariables].
+
+    Attributes:
+        partial_failure_error (google.rpc.status_pb2.Status):
+            Errors that pertain to operation failures in the partial
+            failure mode. Returned only when partial_failure = true and
+            all errors occur inside the operations. If any errors occur
+            outside the operations (for example, auth errors), we return
+            an RPC level error.
+        results (Sequence[google.ads.googleads.v12.services.types.MutateConversionCustomVariableResult]):
+            All results for the mutate.
+    """
+
+    partial_failure_error = proto.Field(
+        proto.MESSAGE, number=1, message=status_pb2.Status,
+    )
+    results = proto.RepeatedField(
+        proto.MESSAGE, number=2, message="MutateConversionCustomVariableResult",
+    )
+
+
+class MutateConversionCustomVariableResult(proto.Message):
+    r"""The result for the conversion custom variable mutate.
+
+    Attributes:
+        resource_name (str):
+            Returned for successful operations.
+        conversion_custom_variable (google.ads.googleads.v12.resources.types.ConversionCustomVariable):
+            The mutated conversion custom variable with only mutable
+            fields after mutate. The field will only be returned when
+            response_content_type is set to "MUTABLE_RESOURCE".
+    """
+
+    resource_name = proto.Field(proto.STRING, number=1,)
+    conversion_custom_variable = proto.Field(
+        proto.MESSAGE,
+        number=2,
+        message=gagr_conversion_custom_variable.ConversionCustomVariable,
+    )
+
+
+__all__ = tuple(sorted(__protobuf__.manifest))

airflow/providers/google_vendor/googleads/v12/services/types/conversion_goal_campaign_config_service.py

@@ -0,0 +1,139 @@
+# -*- coding: utf-8 -*-
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+import proto  # type: ignore
+
+from airflow.providers.google_vendor.googleads.v12.enums.types import (
+    response_content_type as gage_response_content_type,
+)
+from airflow.providers.google_vendor.googleads.v12.resources.types import (
+    conversion_goal_campaign_config as gagr_conversion_goal_campaign_config,
+)
+from google.protobuf import field_mask_pb2  # type: ignore
+
+
+__protobuf__ = proto.module(
+    package="airflow.providers.google_vendor.googleads.v12.services",
+    marshal="google.ads.googleads.v12",
+    manifest={
+        "MutateConversionGoalCampaignConfigsRequest",
+        "ConversionGoalCampaignConfigOperation",
+        "MutateConversionGoalCampaignConfigsResponse",
+        "MutateConversionGoalCampaignConfigResult",
+    },
+)
+
+
+class MutateConversionGoalCampaignConfigsRequest(proto.Message):
+    r"""Request message for
+    [ConversionGoalCampaignConfigService.MutateConversionGoalCampaignConfig][].
+
+    Attributes:
+        customer_id (str):
+            Required. The ID of the customer whose custom
+            conversion goals are being modified.
+        operations (Sequence[google.ads.googleads.v12.services.types.ConversionGoalCampaignConfigOperation]):
+            Required. The list of operations to perform
+            on individual conversion goal campaign config.
+        validate_only (bool):
+            If true, the request is validated but not
+            executed. Only errors are returned, not results.
+        response_content_type (google.ads.googleads.v12.enums.types.ResponseContentTypeEnum.ResponseContentType):
+            The response content type setting. Determines
+            whether the mutable resource or just the
+            resource name should be returned post mutation.
+    """
+
+    customer_id = proto.Field(proto.STRING, number=1,)
+    operations = proto.RepeatedField(
+        proto.MESSAGE,
+        number=2,
+        message="ConversionGoalCampaignConfigOperation",
+    )
+    validate_only = proto.Field(proto.BOOL, number=3,)
+    response_content_type = proto.Field(
+        proto.ENUM,
+        number=4,
+        enum=gage_response_content_type.ResponseContentTypeEnum.ResponseContentType,
+    )
+
+
+class ConversionGoalCampaignConfigOperation(proto.Message):
+    r"""A single operation (update) on a conversion goal campaign
+    config.
+
+
+    .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
+
+    Attributes:
+        update_mask (google.protobuf.field_mask_pb2.FieldMask):
+            FieldMask that determines which resource
+            fields are modified in an update.
+        update (google.ads.googleads.v12.resources.types.ConversionGoalCampaignConfig):
+            Update operation: The conversion goal
+            campaign config is expected to have a valid
+            resource name.
+
+            This field is a member of `oneof`_ ``operation``.
+    """
+
+    update_mask = proto.Field(
+        proto.MESSAGE, number=2, message=field_mask_pb2.FieldMask,
+    )
+    update = proto.Field(
+        proto.MESSAGE,
+        number=1,
+        oneof="operation",
+        message=gagr_conversion_goal_campaign_config.ConversionGoalCampaignConfig,
+    )
+
+
+class MutateConversionGoalCampaignConfigsResponse(proto.Message):
+    r"""Response message for a conversion goal campaign config
+    mutate.
+
+    Attributes:
+        results (Sequence[google.ads.googleads.v12.services.types.MutateConversionGoalCampaignConfigResult]):
+            All results for the mutate.
+    """
+
+    results = proto.RepeatedField(
+        proto.MESSAGE,
+        number=1,
+        message="MutateConversionGoalCampaignConfigResult",
+    )
+
+
+class MutateConversionGoalCampaignConfigResult(proto.Message):
+    r"""The result for the conversion goal campaign config mutate.
+
+    Attributes:
+        resource_name (str):
+            Returned for successful operations.
+        conversion_goal_campaign_config (google.ads.googleads.v12.resources.types.ConversionGoalCampaignConfig):
+            The mutated ConversionGoalCampaignConfig with only mutable
+            fields after mutate. The field will only be returned when
+            response_content_type is set to "MUTABLE_RESOURCE".
+    """
+
+    resource_name = proto.Field(proto.STRING, number=1,)
+    conversion_goal_campaign_config = proto.Field(
+        proto.MESSAGE,
+        number=2,
+        message=gagr_conversion_goal_campaign_config.ConversionGoalCampaignConfig,
+    )
+
+
+__all__ = tuple(sorted(__protobuf__.manifest))