google-ads-nodejs-client
Version:
Googleads client for Node.js
822 lines (684 loc) • 14.8 MB
TypeScript
// Copyright 2026 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 type {protobuf as $protobuf} from "google-gax";
import Long = require("long");
/** Namespace google. */
export namespace google {
/** Namespace ads. */
namespace ads {
/** Namespace googleads. */
namespace googleads {
/** Namespace v24. */
namespace v24 {
/** Namespace actions. */
namespace actions {
/** Properties of a BookCampaignsOperation. */
interface IBookCampaignsOperation {
/** BookCampaignsOperation campaigns */
campaigns?: (google.ads.googleads.v24.actions.BookCampaignsOperation.ICampaign[]|null);
/** BookCampaignsOperation quoteSignature */
quoteSignature?: (string|null);
}
/** Represents a BookCampaignsOperation. */
class BookCampaignsOperation implements IBookCampaignsOperation {
/**
* Constructs a new BookCampaignsOperation.
* @param [properties] Properties to set
*/
constructor(properties?: google.ads.googleads.v24.actions.IBookCampaignsOperation);
/** BookCampaignsOperation campaigns. */
public campaigns: google.ads.googleads.v24.actions.BookCampaignsOperation.ICampaign[];
/** BookCampaignsOperation quoteSignature. */
public quoteSignature: string;
/**
* Creates a new BookCampaignsOperation instance using the specified properties.
* @param [properties] Properties to set
* @returns BookCampaignsOperation instance
*/
public static create(properties?: google.ads.googleads.v24.actions.IBookCampaignsOperation): google.ads.googleads.v24.actions.BookCampaignsOperation;
/**
* Encodes the specified BookCampaignsOperation message. Does not implicitly {@link google.ads.googleads.v24.actions.BookCampaignsOperation.verify|verify} messages.
* @param message BookCampaignsOperation message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.ads.googleads.v24.actions.IBookCampaignsOperation, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified BookCampaignsOperation message, length delimited. Does not implicitly {@link google.ads.googleads.v24.actions.BookCampaignsOperation.verify|verify} messages.
* @param message BookCampaignsOperation message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.ads.googleads.v24.actions.IBookCampaignsOperation, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a BookCampaignsOperation message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns BookCampaignsOperation
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.googleads.v24.actions.BookCampaignsOperation;
/**
* Decodes a BookCampaignsOperation message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns BookCampaignsOperation
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.googleads.v24.actions.BookCampaignsOperation;
/**
* Verifies a BookCampaignsOperation message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a BookCampaignsOperation message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns BookCampaignsOperation
*/
public static fromObject(object: { [k: string]: any }): google.ads.googleads.v24.actions.BookCampaignsOperation;
/**
* Creates a plain object from a BookCampaignsOperation message. Also converts values to other types if specified.
* @param message BookCampaignsOperation
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.ads.googleads.v24.actions.BookCampaignsOperation, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this BookCampaignsOperation to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for BookCampaignsOperation
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
namespace BookCampaignsOperation {
/** Properties of a Campaign. */
interface ICampaign {
/** Campaign campaign */
campaign?: (string|null);
/** Campaign requestType */
requestType?: (google.ads.googleads.v24.enums.ReservationRequestTypeEnum.ReservationRequestType|keyof typeof google.ads.googleads.v24.enums.ReservationRequestTypeEnum.ReservationRequestType|null);
}
/** Represents a Campaign. */
class Campaign implements ICampaign {
/**
* Constructs a new Campaign.
* @param [properties] Properties to set
*/
constructor(properties?: google.ads.googleads.v24.actions.BookCampaignsOperation.ICampaign);
/** Campaign campaign. */
public campaign: string;
/** Campaign requestType. */
public requestType: (google.ads.googleads.v24.enums.ReservationRequestTypeEnum.ReservationRequestType|keyof typeof google.ads.googleads.v24.enums.ReservationRequestTypeEnum.ReservationRequestType);
/**
* Creates a new Campaign instance using the specified properties.
* @param [properties] Properties to set
* @returns Campaign instance
*/
public static create(properties?: google.ads.googleads.v24.actions.BookCampaignsOperation.ICampaign): google.ads.googleads.v24.actions.BookCampaignsOperation.Campaign;
/**
* Encodes the specified Campaign message. Does not implicitly {@link google.ads.googleads.v24.actions.BookCampaignsOperation.Campaign.verify|verify} messages.
* @param message Campaign message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.ads.googleads.v24.actions.BookCampaignsOperation.ICampaign, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified Campaign message, length delimited. Does not implicitly {@link google.ads.googleads.v24.actions.BookCampaignsOperation.Campaign.verify|verify} messages.
* @param message Campaign message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.ads.googleads.v24.actions.BookCampaignsOperation.ICampaign, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a Campaign message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns Campaign
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.googleads.v24.actions.BookCampaignsOperation.Campaign;
/**
* Decodes a Campaign message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns Campaign
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.googleads.v24.actions.BookCampaignsOperation.Campaign;
/**
* Verifies a Campaign message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a Campaign message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns Campaign
*/
public static fromObject(object: { [k: string]: any }): google.ads.googleads.v24.actions.BookCampaignsOperation.Campaign;
/**
* Creates a plain object from a Campaign message. Also converts values to other types if specified.
* @param message Campaign
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.ads.googleads.v24.actions.BookCampaignsOperation.Campaign, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this Campaign to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for Campaign
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
}
/** Properties of a BookCampaignsResult. */
interface IBookCampaignsResult {
}
/** Represents a BookCampaignsResult. */
class BookCampaignsResult implements IBookCampaignsResult {
/**
* Constructs a new BookCampaignsResult.
* @param [properties] Properties to set
*/
constructor(properties?: google.ads.googleads.v24.actions.IBookCampaignsResult);
/**
* Creates a new BookCampaignsResult instance using the specified properties.
* @param [properties] Properties to set
* @returns BookCampaignsResult instance
*/
public static create(properties?: google.ads.googleads.v24.actions.IBookCampaignsResult): google.ads.googleads.v24.actions.BookCampaignsResult;
/**
* Encodes the specified BookCampaignsResult message. Does not implicitly {@link google.ads.googleads.v24.actions.BookCampaignsResult.verify|verify} messages.
* @param message BookCampaignsResult message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.ads.googleads.v24.actions.IBookCampaignsResult, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified BookCampaignsResult message, length delimited. Does not implicitly {@link google.ads.googleads.v24.actions.BookCampaignsResult.verify|verify} messages.
* @param message BookCampaignsResult message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.ads.googleads.v24.actions.IBookCampaignsResult, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a BookCampaignsResult message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns BookCampaignsResult
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.googleads.v24.actions.BookCampaignsResult;
/**
* Decodes a BookCampaignsResult message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns BookCampaignsResult
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.googleads.v24.actions.BookCampaignsResult;
/**
* Verifies a BookCampaignsResult message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a BookCampaignsResult message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns BookCampaignsResult
*/
public static fromObject(object: { [k: string]: any }): google.ads.googleads.v24.actions.BookCampaignsResult;
/**
* Creates a plain object from a BookCampaignsResult message. Also converts values to other types if specified.
* @param message BookCampaignsResult
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.ads.googleads.v24.actions.BookCampaignsResult, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this BookCampaignsResult to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for BookCampaignsResult
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a GenerateShareablePreviewsOperation. */
interface IGenerateShareablePreviewsOperation {
/** GenerateShareablePreviewsOperation shareablePreviews */
shareablePreviews?: (google.ads.googleads.v24.actions.IShareablePreview[]|null);
}
/** Represents a GenerateShareablePreviewsOperation. */
class GenerateShareablePreviewsOperation implements IGenerateShareablePreviewsOperation {
/**
* Constructs a new GenerateShareablePreviewsOperation.
* @param [properties] Properties to set
*/
constructor(properties?: google.ads.googleads.v24.actions.IGenerateShareablePreviewsOperation);
/** GenerateShareablePreviewsOperation shareablePreviews. */
public shareablePreviews: google.ads.googleads.v24.actions.IShareablePreview[];
/**
* Creates a new GenerateShareablePreviewsOperation instance using the specified properties.
* @param [properties] Properties to set
* @returns GenerateShareablePreviewsOperation instance
*/
public static create(properties?: google.ads.googleads.v24.actions.IGenerateShareablePreviewsOperation): google.ads.googleads.v24.actions.GenerateShareablePreviewsOperation;
/**
* Encodes the specified GenerateShareablePreviewsOperation message. Does not implicitly {@link google.ads.googleads.v24.actions.GenerateShareablePreviewsOperation.verify|verify} messages.
* @param message GenerateShareablePreviewsOperation message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.ads.googleads.v24.actions.IGenerateShareablePreviewsOperation, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified GenerateShareablePreviewsOperation message, length delimited. Does not implicitly {@link google.ads.googleads.v24.actions.GenerateShareablePreviewsOperation.verify|verify} messages.
* @param message GenerateShareablePreviewsOperation message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.ads.googleads.v24.actions.IGenerateShareablePreviewsOperation, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a GenerateShareablePreviewsOperation message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns GenerateShareablePreviewsOperation
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.googleads.v24.actions.GenerateShareablePreviewsOperation;
/**
* Decodes a GenerateShareablePreviewsOperation message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns GenerateShareablePreviewsOperation
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.googleads.v24.actions.GenerateShareablePreviewsOperation;
/**
* Verifies a GenerateShareablePreviewsOperation message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a GenerateShareablePreviewsOperation message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns GenerateShareablePreviewsOperation
*/
public static fromObject(object: { [k: string]: any }): google.ads.googleads.v24.actions.GenerateShareablePreviewsOperation;
/**
* Creates a plain object from a GenerateShareablePreviewsOperation message. Also converts values to other types if specified.
* @param message GenerateShareablePreviewsOperation
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.ads.googleads.v24.actions.GenerateShareablePreviewsOperation, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this GenerateShareablePreviewsOperation to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for GenerateShareablePreviewsOperation
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a ShareablePreview. */
interface IShareablePreview {
/** ShareablePreview previewType */
previewType?: (google.ads.googleads.v24.enums.PreviewTypeEnum.PreviewType|keyof typeof google.ads.googleads.v24.enums.PreviewTypeEnum.PreviewType|null);
/** ShareablePreview adGroupAd */
adGroupAd?: (string|null);
/** ShareablePreview assetGroup */
assetGroup?: (string|null);
}
/** Represents a ShareablePreview. */
class ShareablePreview implements IShareablePreview {
/**
* Constructs a new ShareablePreview.
* @param [properties] Properties to set
*/
constructor(properties?: google.ads.googleads.v24.actions.IShareablePreview);
/** ShareablePreview previewType. */
public previewType: (google.ads.googleads.v24.enums.PreviewTypeEnum.PreviewType|keyof typeof google.ads.googleads.v24.enums.PreviewTypeEnum.PreviewType);
/** ShareablePreview adGroupAd. */
public adGroupAd?: (string|null);
/** ShareablePreview assetGroup. */
public assetGroup?: (string|null);
/** ShareablePreview identifier. */
public identifier?: ("adGroupAd"|"assetGroup");
/**
* Creates a new ShareablePreview instance using the specified properties.
* @param [properties] Properties to set
* @returns ShareablePreview instance
*/
public static create(properties?: google.ads.googleads.v24.actions.IShareablePreview): google.ads.googleads.v24.actions.ShareablePreview;
/**
* Encodes the specified ShareablePreview message. Does not implicitly {@link google.ads.googleads.v24.actions.ShareablePreview.verify|verify} messages.
* @param message ShareablePreview message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.ads.googleads.v24.actions.IShareablePreview, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified ShareablePreview message, length delimited. Does not implicitly {@link google.ads.googleads.v24.actions.ShareablePreview.verify|verify} messages.
* @param message ShareablePreview message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.ads.googleads.v24.actions.IShareablePreview, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a ShareablePreview message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns ShareablePreview
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.googleads.v24.actions.ShareablePreview;
/**
* Decodes a ShareablePreview message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns ShareablePreview
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.googleads.v24.actions.ShareablePreview;
/**
* Verifies a ShareablePreview message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a ShareablePreview message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ShareablePreview
*/
public static fromObject(object: { [k: string]: any }): google.ads.googleads.v24.actions.ShareablePreview;
/**
* Creates a plain object from a ShareablePreview message. Also converts values to other types if specified.
* @param message ShareablePreview
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.ads.googleads.v24.actions.ShareablePreview, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ShareablePreview to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ShareablePreview
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a GenerateShareablePreviewsResult. */
interface IGenerateShareablePreviewsResult {
/** GenerateShareablePreviewsResult previews */
previews?: (google.ads.googleads.v24.actions.IShareablePreviewResult[]|null);
}
/** Represents a GenerateShareablePreviewsResult. */
class GenerateShareablePreviewsResult implements IGenerateShareablePreviewsResult {
/**
* Constructs a new GenerateShareablePreviewsResult.
* @param [properties] Properties to set
*/
constructor(properties?: google.ads.googleads.v24.actions.IGenerateShareablePreviewsResult);
/** GenerateShareablePreviewsResult previews. */
public previews: google.ads.googleads.v24.actions.IShareablePreviewResult[];
/**
* Creates a new GenerateShareablePreviewsResult instance using the specified properties.
* @param [properties] Properties to set
* @returns GenerateShareablePreviewsResult instance
*/
public static create(properties?: google.ads.googleads.v24.actions.IGenerateShareablePreviewsResult): google.ads.googleads.v24.actions.GenerateShareablePreviewsResult;
/**
* Encodes the specified GenerateShareablePreviewsResult message. Does not implicitly {@link google.ads.googleads.v24.actions.GenerateShareablePreviewsResult.verify|verify} messages.
* @param message GenerateShareablePreviewsResult message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.ads.googleads.v24.actions.IGenerateShareablePreviewsResult, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified GenerateShareablePreviewsResult message, length delimited. Does not implicitly {@link google.ads.googleads.v24.actions.GenerateShareablePreviewsResult.verify|verify} messages.
* @param message GenerateShareablePreviewsResult message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.ads.googleads.v24.actions.IGenerateShareablePreviewsResult, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a GenerateShareablePreviewsResult message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns GenerateShareablePreviewsResult
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.googleads.v24.actions.GenerateShareablePreviewsResult;
/**
* Decodes a GenerateShareablePreviewsResult message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns GenerateShareablePreviewsResult
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.googleads.v24.actions.GenerateShareablePreviewsResult;
/**
* Verifies a GenerateShareablePreviewsResult message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a GenerateShareablePreviewsResult message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns GenerateShareablePreviewsResult
*/
public static fromObject(object: { [k: string]: any }): google.ads.googleads.v24.actions.GenerateShareablePreviewsResult;
/**
* Creates a plain object from a GenerateShareablePreviewsResult message. Also converts values to other types if specified.
* @param message GenerateShareablePreviewsResult
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.ads.googleads.v24.actions.GenerateShareablePreviewsResult, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this GenerateShareablePreviewsResult to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for GenerateShareablePreviewsResult
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a ShareablePreviewResult. */
interface IShareablePreviewResult {
/** ShareablePreviewResult expirationDateTime */
expirationDateTime?: (string|null);
/** ShareablePreviewResult uiPreviewResult */
uiPreviewResult?: (google.ads.googleads.v24.actions.IUiPreviewResult|null);
/** ShareablePreviewResult youtubeLivePreviewResult */
youtubeLivePreviewResult?: (google.ads.googleads.v24.actions.IYouTubeLivePreviewResult|null);
/** ShareablePreviewResult adGroupAd */
adGroupAd?: (string|null);
/** ShareablePreviewResult assetGroup */
assetGroup?: (string|null);
}
/** Represents a ShareablePreviewResult. */
class ShareablePreviewResult implements IShareablePreviewResult {
/**
* Constructs a new ShareablePreviewResult.
* @param [properties] Properties to set
*/
constructor(properties?: google.ads.googleads.v24.actions.IShareablePreviewResult);
/** ShareablePreviewResult expirationDateTime. */
public expirationDateTime: string;
/** ShareablePreviewResult uiPreviewResult. */
public uiPreviewResult?: (google.ads.googleads.v24.actions.IUiPreviewResult|null);
/** ShareablePreviewResult youtubeLivePreviewResult. */
public youtubeLivePreviewResult?: (google.ads.googleads.v24.actions.IYouTubeLivePreviewResult|null);
/** ShareablePreviewResult adGroupAd. */
public adGroupAd?: (string|null);
/** ShareablePreviewResult assetGroup. */
public assetGroup?: (string|null);
/** ShareablePreviewResult result. */
public result?: ("uiPreviewResult"|"youtubeLivePreviewResult");
/** ShareablePreviewResult identifier. */
public identifier?: ("adGroupAd"|"assetGroup");
/**
* Creates a new ShareablePreviewResult instance using the specified properties.
* @param [properties] Properties to set
* @returns ShareablePreviewResult instance
*/
public static create(properties?: google.ads.googleads.v24.actions.IShareablePreviewResult): google.ads.googleads.v24.actions.ShareablePreviewResult;
/**
* Encodes the specified ShareablePreviewResult message. Does not implicitly {@link google.ads.googleads.v24.actions.ShareablePreviewResult.verify|verify} messages.
* @param message ShareablePreviewResult message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.ads.googleads.v24.actions.IShareablePreviewResult, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified ShareablePreviewResult message, length delimited. Does not implicitly {@link google.ads.googleads.v24.actions.ShareablePreviewResult.verify|verify} messages.
* @param message ShareablePreviewResult message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.ads.googleads.v24.actions.IShareablePreviewResult, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a ShareablePreviewResult message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns ShareablePreviewResult
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.googleads.v24.actions.ShareablePreviewResult;
/**
* Decodes a ShareablePreviewResult message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns ShareablePreviewResult
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.ads.googleads.v24.actions.ShareablePreviewResult;
/**
* Verifies a ShareablePreviewResult message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a ShareablePreviewResult message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ShareablePreviewResult
*/
public static fromObject(object: { [k: string]: any }): google.ads.googleads.v24.actions.ShareablePreviewResult;
/**
* Creates a plain object from a ShareablePreviewResult message. Also converts values to other types if specified.
* @param message ShareablePreviewResult
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.ads.googleads.v24.actions.ShareablePreviewResult, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ShareablePreviewResult to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ShareablePreviewResult
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an UiPreviewResult. */
interface IUiPreviewResult {
/** UiPreviewResult shareablePreviewUrl */
shareablePreviewUrl?: (string|null);
}
/** Represents an UiPreviewResult. */
class UiPreviewResult implements IUiPreviewResult {
/**
* Constructs a new UiPreviewResult.
* @param [properties] Properties to set
*/
constructor(properties?: google.ads.googleads.v24.actions.IUiPreviewResult);
/** UiPreviewResult shareablePreviewUrl. */
public shareablePreviewUrl: string;
/**
* Creates a new UiPreviewResult instance using the specified properties.
* @param [properties] Properties to set
* @returns UiPreviewResult instance
*/
public static create(properties?: google.ads.googleads.v24.actions.IUiPreviewResult): google.ads.googleads.v24.actions.UiPreviewResult;
/**
* Encodes the specified UiPreviewResult message. Does not implicitly {@link google.ads.googleads.v24.actions.UiPreviewResult.verify|verify} messages.
* @param message UiPreviewResult message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.ads.googleads.v24.actions.IUiPreviewResult, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified UiPreviewResult message, length delimited. Does not implicitly {@link google.ads.googleads.v24.actions.UiPreviewResult.verify|verify} messages.
* @param message UiPreviewResult message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.ads.googleads.v24.actions.IUiPreviewResult, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an UiPreviewResult message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns UiPreviewResult
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.ads.googleads.v24.actions.UiPreviewResult;
/**
* Decodes an UiPreviewResult message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns UiPreviewResult
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields