# -*- coding: utf-8 -*-
# Copyright 2025 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.
#
from __future__ import annotations

from typing import MutableMapping, MutableSequence

import google.protobuf.field_mask_pb2 as field_mask_pb2  # type: ignore
import proto  # type: ignore

from google.ads.admanager_v1.types import custom_targeting_key_messages

__protobuf__ = proto.module(
    package="google.ads.admanager.v1",
    manifest={
        "GetCustomTargetingKeyRequest",
        "ListCustomTargetingKeysRequest",
        "ListCustomTargetingKeysResponse",
        "CreateCustomTargetingKeyRequest",
        "BatchCreateCustomTargetingKeysRequest",
        "BatchCreateCustomTargetingKeysResponse",
        "UpdateCustomTargetingKeyRequest",
        "BatchUpdateCustomTargetingKeysRequest",
        "BatchUpdateCustomTargetingKeysResponse",
        "BatchActivateCustomTargetingKeysRequest",
        "BatchActivateCustomTargetingKeysResponse",
        "BatchDeactivateCustomTargetingKeysRequest",
        "BatchDeactivateCustomTargetingKeysResponse",
    },
)


class GetCustomTargetingKeyRequest(proto.Message):
    r"""Request object for ``GetCustomTargetingKey`` method.

    Attributes:
        name (str):
            Required. The resource name of the CustomTargetingKey.
            Format:
            ``networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}``
    """

    name: str = proto.Field(
        proto.STRING,
        number=1,
    )


class ListCustomTargetingKeysRequest(proto.Message):
    r"""Request object for ``ListCustomTargetingKeys`` method.

    Attributes:
        parent (str):
            Required. The parent, which owns this collection of
            CustomTargetingKeys. Format: ``networks/{network_code}``
        page_size (int):
            Optional. The maximum number of ``CustomTargetingKeys`` to
            return. The service may return fewer than this value. If
            unspecified, at most 50 ``CustomTargetingKeys`` will be
            returned. The maximum value is 1000; values above 1000 will
            be coerced to 1000.
        page_token (str):
            Optional. A page token, received from a previous
            ``ListCustomTargetingKeys`` call. Provide this to retrieve
            the subsequent page.

            When paginating, all other parameters provided to
            ``ListCustomTargetingKeys`` must match the call that
            provided the page token.
        filter (str):
            Optional. Expression to filter the response.
            See syntax details at
            https://developers.google.com/ad-manager/api/beta/filters
        order_by (str):
            Optional. Expression to specify sorting
            order. See syntax details at
            https://developers.google.com/ad-manager/api/beta/filters#order
        skip (int):
            Optional. Number of individual resources to
            skip while paginating.
    """

    parent: str = proto.Field(
        proto.STRING,
        number=1,
    )
    page_size: int = proto.Field(
        proto.INT32,
        number=2,
    )
    page_token: str = proto.Field(
        proto.STRING,
        number=3,
    )
    filter: str = proto.Field(
        proto.STRING,
        number=4,
    )
    order_by: str = proto.Field(
        proto.STRING,
        number=5,
    )
    skip: int = proto.Field(
        proto.INT32,
        number=6,
    )


class ListCustomTargetingKeysResponse(proto.Message):
    r"""Response object for ``ListCustomTargetingKeysRequest`` containing
    matching ``CustomTargetingKey`` objects.

    Attributes:
        custom_targeting_keys (MutableSequence[google.ads.admanager_v1.types.CustomTargetingKey]):
            The ``CustomTargetingKey`` objects from the specified
            network.
        next_page_token (str):
            A token, which can be sent as ``page_token`` to retrieve the
            next page. If this field is omitted, there are no subsequent
            pages.
        total_size (int):
            Total number of ``CustomTargetingKey`` objects. If a filter
            was included in the request, this reflects the total number
            after the filtering is applied.

            ``total_size`` won't be calculated in the response unless it
            has been included in a response field mask. The response
            field mask can be provided to the method by using the URL
            parameter ``$fields`` or ``fields``, or by using the
            HTTP/gRPC header ``X-Goog-FieldMask``.

            For more information, see
            https://developers.google.com/ad-manager/api/beta/field-masks
    """

    @property
    def raw_page(self):
        return self

    custom_targeting_keys: MutableSequence[
        custom_targeting_key_messages.CustomTargetingKey
    ] = proto.RepeatedField(
        proto.MESSAGE,
        number=1,
        message=custom_targeting_key_messages.CustomTargetingKey,
    )
    next_page_token: str = proto.Field(
        proto.STRING,
        number=2,
    )
    total_size: int = proto.Field(
        proto.INT32,
        number=3,
    )


class CreateCustomTargetingKeyRequest(proto.Message):
    r"""Request object for ``CreateCustomTargetingKey`` method.

    Attributes:
        parent (str):
            Required. The parent resource where this
            ``CustomTargetingKey`` will be created. Format:
            ``networks/{network_code}``
        custom_targeting_key (google.ads.admanager_v1.types.CustomTargetingKey):
            Required. The ``CustomTargetingKey`` to create.
    """

    parent: str = proto.Field(
        proto.STRING,
        number=1,
    )
    custom_targeting_key: custom_targeting_key_messages.CustomTargetingKey = (
        proto.Field(
            proto.MESSAGE,
            number=2,
            message=custom_targeting_key_messages.CustomTargetingKey,
        )
    )


class BatchCreateCustomTargetingKeysRequest(proto.Message):
    r"""Request object for ``BatchCreateCustomTargetingKeys`` method.

    Attributes:
        parent (str):
            Required. The parent resource where ``CustomTargetingKeys``
            will be created. Format: ``networks/{network_code}`` The
            parent field in the CreateCustomTargetingKeyRequest must
            match this field.
        requests (MutableSequence[google.ads.admanager_v1.types.CreateCustomTargetingKeyRequest]):
            Required. The ``CustomTargetingKey`` objects to create. A
            maximum of 100 objects can be created in a batch.
    """

    parent: str = proto.Field(
        proto.STRING,
        number=1,
    )
    requests: MutableSequence["CreateCustomTargetingKeyRequest"] = proto.RepeatedField(
        proto.MESSAGE,
        number=2,
        message="CreateCustomTargetingKeyRequest",
    )


class BatchCreateCustomTargetingKeysResponse(proto.Message):
    r"""Response object for ``BatchCreateCustomTargetingKeys`` method.

    Attributes:
        custom_targeting_keys (MutableSequence[google.ads.admanager_v1.types.CustomTargetingKey]):
            The ``CustomTargetingKey`` objects created.
    """

    custom_targeting_keys: MutableSequence[
        custom_targeting_key_messages.CustomTargetingKey
    ] = proto.RepeatedField(
        proto.MESSAGE,
        number=1,
        message=custom_targeting_key_messages.CustomTargetingKey,
    )


class UpdateCustomTargetingKeyRequest(proto.Message):
    r"""Request object for ``UpdateCustomTargetingKey`` method.

    Attributes:
        custom_targeting_key (google.ads.admanager_v1.types.CustomTargetingKey):
            Required. The ``CustomTargetingKey`` to update.

            The ``CustomTargetingKey``'s ``name`` is used to identify
            the ``CustomTargetingKey`` to update.
        update_mask (google.protobuf.field_mask_pb2.FieldMask):
            Required. The list of fields to update.
    """

    custom_targeting_key: custom_targeting_key_messages.CustomTargetingKey = (
        proto.Field(
            proto.MESSAGE,
            number=1,
            message=custom_targeting_key_messages.CustomTargetingKey,
        )
    )
    update_mask: field_mask_pb2.FieldMask = proto.Field(
        proto.MESSAGE,
        number=2,
        message=field_mask_pb2.FieldMask,
    )


class BatchUpdateCustomTargetingKeysRequest(proto.Message):
    r"""Request object for ``BatchUpdateCustomTargetingKeys`` method.

    Attributes:
        parent (str):
            Required. The parent resource where ``CustomTargetingKeys``
            will be updated. Format: ``networks/{network_code}`` The
            parent field in the UpdateCustomTargetingKeyRequest must
            match this field.
        requests (MutableSequence[google.ads.admanager_v1.types.UpdateCustomTargetingKeyRequest]):
            Required. The ``CustomTargetingKey`` objects to update. A
            maximum of 100 objects can be updated in a batch.
    """

    parent: str = proto.Field(
        proto.STRING,
        number=1,
    )
    requests: MutableSequence["UpdateCustomTargetingKeyRequest"] = proto.RepeatedField(
        proto.MESSAGE,
        number=2,
        message="UpdateCustomTargetingKeyRequest",
    )


class BatchUpdateCustomTargetingKeysResponse(proto.Message):
    r"""Response object for ``BatchUpdateCustomTargetingKeys`` method.

    Attributes:
        custom_targeting_keys (MutableSequence[google.ads.admanager_v1.types.CustomTargetingKey]):
            The ``CustomTargetingKey`` objects updated.
    """

    custom_targeting_keys: MutableSequence[
        custom_targeting_key_messages.CustomTargetingKey
    ] = proto.RepeatedField(
        proto.MESSAGE,
        number=1,
        message=custom_targeting_key_messages.CustomTargetingKey,
    )


class BatchActivateCustomTargetingKeysRequest(proto.Message):
    r"""Request object for ``BatchActivateCustomTargetingKeys`` method.

    Attributes:
        parent (str):
            Required. Format: ``networks/{network_code}``
        names (MutableSequence[str]):
            Required. The resource names of the
            ``CustomTargetingKey``\ s to activate. Format:
            ``networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}``
    """

    parent: str = proto.Field(
        proto.STRING,
        number=1,
    )
    names: MutableSequence[str] = proto.RepeatedField(
        proto.STRING,
        number=2,
    )


class BatchActivateCustomTargetingKeysResponse(proto.Message):
    r"""Response object for ``BatchActivateCustomTargetingKeys`` method."""


class BatchDeactivateCustomTargetingKeysRequest(proto.Message):
    r"""Request message for ``BatchDeactivateCustomTargetingKeys`` method.

    Attributes:
        parent (str):
            Required. Format: ``networks/{network_code}``
        names (MutableSequence[str]):
            Required. The resource names of the
            ``CustomTargetingKey``\ s to deactivate. Format:
            ``networks/{network_code}/customTargetingKeys/{custom_targeting_key_id}``
    """

    parent: str = proto.Field(
        proto.STRING,
        number=1,
    )
    names: MutableSequence[str] = proto.RepeatedField(
        proto.STRING,
        number=2,
    )


class BatchDeactivateCustomTargetingKeysResponse(proto.Message):
    r"""Response object for ``BatchDeactivateCustomTargetingKeys`` method."""


__all__ = tuple(sorted(__protobuf__.manifest))
