google-ads-api-client/dist/protos/bindings/ads/services/ad_group_criterion_service.d.ts

A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.

import { ServiceType } from "@protobuf-ts/runtime-rpc";
import type { BinaryWriteOptions } from "@protobuf-ts/runtime";
import type { IBinaryWriter } from "@protobuf-ts/runtime";
import type { BinaryReadOptions } from "@protobuf-ts/runtime";
import type { IBinaryReader } from "@protobuf-ts/runtime";
import type { PartialMessage } from "@protobuf-ts/runtime";
import { MessageType } from "@protobuf-ts/runtime";
import { Status } from "../../google/rpc/status";
import { AdGroupCriterion } from "../resources/ad_group_criterion";
import { PolicyViolationKey } from "../common/policy";
import { FieldMask } from "../../google/protobuf/field_mask";
import { ResponseContentTypeEnum_ResponseContentType } from "../enums/response_content_type";
/**
 * Request message for [AdGroupCriterionService.MutateAdGroupCriteria][google.ads.googleads.v11.services.AdGroupCriterionService.MutateAdGroupCriteria].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAdGroupCriteriaRequest
 */
export interface MutateAdGroupCriteriaRequest {
    /**
     * Required. ID of the customer whose criteria are being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on individual criteria.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.AdGroupCriterionOperation operations = 2;
     */
    operations: AdGroupCriterionOperation[];
    /**
     * 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.
     *
     * @generated from protobuf field: bool partial_failure = 3;
     */
    partialFailure: boolean;
    /**
     * If true, the request is validated but not executed. Only errors are
     * returned, not results.
     *
     * @generated from protobuf field: bool validate_only = 4;
     */
    validateOnly: boolean;
    /**
     * The response content type setting. Determines whether the mutable resource
     * or just the resource name should be returned post mutation.
     *
     * @generated from protobuf field: google.ads.googleads.v11.enums.ResponseContentTypeEnum.ResponseContentType response_content_type = 5;
     */
    responseContentType: ResponseContentTypeEnum_ResponseContentType;
}
/**
 * A single operation (create, remove, update) on an ad group criterion.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.AdGroupCriterionOperation
 */
export interface AdGroupCriterionOperation {
    /**
     * FieldMask that determines which resource fields are modified in an update.
     *
     * @generated from protobuf field: google.protobuf.FieldMask update_mask = 4;
     */
    updateMask?: FieldMask;
    /**
     * The list of policy violation keys that should not cause a
     * PolicyViolationError to be reported. Not all policy violations are
     * exemptable, refer to the is_exemptible field in the returned
     * PolicyViolationError.
     *
     * Resources violating these polices will be saved, but will not be eligible
     * to serve. They may begin serving at a later time due to a change in
     * policies, re-review of the resource, or a change in advertiser
     * certificates.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.common.PolicyViolationKey exempt_policy_violation_keys = 5;
     */
    exemptPolicyViolationKeys: PolicyViolationKey[];
    /**
     * @generated from protobuf oneof: operation
     */
    operation: {
        oneofKind: "create";
        /**
         * Create operation: No resource name is expected for the new criterion.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.AdGroupCriterion create = 1;
         */
        create: AdGroupCriterion;
    } | {
        oneofKind: "update";
        /**
         * Update operation: The criterion is expected to have a valid resource
         * name.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.AdGroupCriterion update = 2;
         */
        update: AdGroupCriterion;
    } | {
        oneofKind: "remove";
        /**
         * Remove operation: A resource name for the removed criterion is expected,
         * in this format:
         *
         * `customers/{customer_id}/adGroupCriteria/{ad_group_id}~{criterion_id}`
         *
         * @generated from protobuf field: string remove = 3;
         */
        remove: string;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for an ad group criterion mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAdGroupCriteriaResponse
 */
export interface MutateAdGroupCriteriaResponse {
    /**
     * 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.
     *
     * @generated from protobuf field: google.rpc.Status partial_failure_error = 3;
     */
    partialFailureError?: Status;
    /**
     * All results for the mutate.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateAdGroupCriterionResult results = 2;
     */
    results: MutateAdGroupCriterionResult[];
}
/**
 * The result for the criterion mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateAdGroupCriterionResult
 */
export interface MutateAdGroupCriterionResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
    /**
     * The mutated ad group criterion with only mutable fields after mutate. The
     * field will only be returned when response_content_type is set to
     * "MUTABLE_RESOURCE".
     *
     * @generated from protobuf field: google.ads.googleads.v11.resources.AdGroupCriterion ad_group_criterion = 2;
     */
    adGroupCriterion?: AdGroupCriterion;
}
declare class MutateAdGroupCriteriaRequest$Type extends MessageType<MutateAdGroupCriteriaRequest> {
    constructor();
    create(value?: PartialMessage<MutateAdGroupCriteriaRequest>): MutateAdGroupCriteriaRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAdGroupCriteriaRequest): MutateAdGroupCriteriaRequest;
    internalBinaryWrite(message: MutateAdGroupCriteriaRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAdGroupCriteriaRequest
 */
export declare const MutateAdGroupCriteriaRequest: MutateAdGroupCriteriaRequest$Type;
declare class AdGroupCriterionOperation$Type extends MessageType<AdGroupCriterionOperation> {
    constructor();
    create(value?: PartialMessage<AdGroupCriterionOperation>): AdGroupCriterionOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: AdGroupCriterionOperation): AdGroupCriterionOperation;
    internalBinaryWrite(message: AdGroupCriterionOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.AdGroupCriterionOperation
 */
export declare const AdGroupCriterionOperation: AdGroupCriterionOperation$Type;
declare class MutateAdGroupCriteriaResponse$Type extends MessageType<MutateAdGroupCriteriaResponse> {
    constructor();
    create(value?: PartialMessage<MutateAdGroupCriteriaResponse>): MutateAdGroupCriteriaResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAdGroupCriteriaResponse): MutateAdGroupCriteriaResponse;
    internalBinaryWrite(message: MutateAdGroupCriteriaResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAdGroupCriteriaResponse
 */
export declare const MutateAdGroupCriteriaResponse: MutateAdGroupCriteriaResponse$Type;
declare class MutateAdGroupCriterionResult$Type extends MessageType<MutateAdGroupCriterionResult> {
    constructor();
    create(value?: PartialMessage<MutateAdGroupCriterionResult>): MutateAdGroupCriterionResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateAdGroupCriterionResult): MutateAdGroupCriterionResult;
    internalBinaryWrite(message: MutateAdGroupCriterionResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateAdGroupCriterionResult
 */
export declare const MutateAdGroupCriterionResult: MutateAdGroupCriterionResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.AdGroupCriterionService
 */
export declare const AdGroupCriterionService: ServiceType;
export {};