@google-ads/admanager 0.9.0 → 0.11.0

package/build/src/v1/network_service_client.d.ts

@@ -139,6 +139,92 @@ export declare class NetworkServiceClient {
     ]>;
     getNetwork(request: protos.google.ads.admanager.v1.IGetNetworkRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.INetwork, protos.google.ads.admanager.v1.IGetNetworkRequest | null | undefined, {} | null | undefined>): void;
     getNetwork(request: protos.google.ads.admanager.v1.IGetNetworkRequest, callback: Callback<protos.google.ads.admanager.v1.INetwork, protos.google.ads.admanager.v1.IGetNetworkRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Updates a `Network` object. Currently, only the network display name can be
+     * updated.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {google.ads.admanager.v1.Network} request.network
+     *   Required. The `Network` to update.
+     *
+     *   The `Network`'s `name` is used to identify the `Network` to update.
+     * @param {google.protobuf.FieldMask} [request.updateMask]
+     *   Optional. The list of fields to update.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.ads.admanager.v1.Network|Network}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/network_service.update_network.js</caption>
+     * region_tag:admanager_v1_generated_NetworkService_UpdateNetwork_async
+     */
+    updateNetwork(request?: protos.google.ads.admanager.v1.IUpdateNetworkRequest, options?: CallOptions): Promise<[
+        protos.google.ads.admanager.v1.INetwork,
+        protos.google.ads.admanager.v1.IUpdateNetworkRequest | undefined,
+        {} | undefined
+    ]>;
+    updateNetwork(request: protos.google.ads.admanager.v1.IUpdateNetworkRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.INetwork, protos.google.ads.admanager.v1.IUpdateNetworkRequest | null | undefined, {} | null | undefined>): void;
+    updateNetwork(request: protos.google.ads.admanager.v1.IUpdateNetworkRequest, callback: Callback<protos.google.ads.admanager.v1.INetwork, protos.google.ads.admanager.v1.IUpdateNetworkRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Provisions a test network associated with the current user. Only one test
+     * network can be provisioned per user.
+     *
+     * Before the test network can be used, you must complete setup in the Ad
+     * Manager UI. If the test network's owner is a service account, you must add
+     * a non-service account user by calling UserService.CreateUser.
+     *
+     * Test networks are limited in the following ways:
+     *
+     *   * Test networks have a maximum of 10,000 objects per entity type.
+     *   * Test networks cannot serve ads.
+     *   * Reports on serving data have zero rows.
+     *   * Forecast service results contain mock data.
+     *   * Test networks do not have Ad Manager 360 or premium features enabled.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.ads.admanager.v1.Network|Network}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/network_service.provision_test_network.js</caption>
+     * region_tag:admanager_v1_generated_NetworkService_ProvisionTestNetwork_async
+     */
+    provisionTestNetwork(request?: protos.google.ads.admanager.v1.IProvisionTestNetworkRequest, options?: CallOptions): Promise<[
+        protos.google.ads.admanager.v1.INetwork,
+        protos.google.ads.admanager.v1.IProvisionTestNetworkRequest | undefined,
+        {} | undefined
+    ]>;
+    provisionTestNetwork(request: protos.google.ads.admanager.v1.IProvisionTestNetworkRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.INetwork, protos.google.ads.admanager.v1.IProvisionTestNetworkRequest | null | undefined, {} | null | undefined>): void;
+    provisionTestNetwork(request: protos.google.ads.admanager.v1.IProvisionTestNetworkRequest, callback: Callback<protos.google.ads.admanager.v1.INetwork, protos.google.ads.admanager.v1.IProvisionTestNetworkRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Returns the [DefaultThirdPartyDataDeclaration] for this network.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.name
+     *   Required. Resource name of DefaultThirdPartyDataDeclaration.
+     *   Format: networks/{network_code}/defaultThirdPartyDataDeclaration
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.ads.admanager.v1.DefaultThirdPartyDataDeclaration|DefaultThirdPartyDataDeclaration}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/network_service.get_default_third_party_data_declaration.js</caption>
+     * region_tag:admanager_v1_generated_NetworkService_GetDefaultThirdPartyDataDeclaration_async
+     */
+    getDefaultThirdPartyDataDeclaration(request?: protos.google.ads.admanager.v1.IGetDefaultThirdPartyDataDeclarationRequest, options?: CallOptions): Promise<[
+        protos.google.ads.admanager.v1.IDefaultThirdPartyDataDeclaration,
+        (protos.google.ads.admanager.v1.IGetDefaultThirdPartyDataDeclarationRequest | undefined),
+        {} | undefined
+    ]>;
+    getDefaultThirdPartyDataDeclaration(request: protos.google.ads.admanager.v1.IGetDefaultThirdPartyDataDeclarationRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IDefaultThirdPartyDataDeclaration, protos.google.ads.admanager.v1.IGetDefaultThirdPartyDataDeclarationRequest | null | undefined, {} | null | undefined>): void;
+    getDefaultThirdPartyDataDeclaration(request: protos.google.ads.admanager.v1.IGetDefaultThirdPartyDataDeclarationRequest, callback: Callback<protos.google.ads.admanager.v1.IDefaultThirdPartyDataDeclaration, protos.google.ads.admanager.v1.IGetDefaultThirdPartyDataDeclarationRequest | null | undefined, {} | null | undefined>): void;
     /**
      * Retrieves all the networks the current user has access to.
      *
@@ -783,6 +869,30 @@ export declare class NetworkServiceClient {
      * @returns {string} A string representing the creative_template.
      */
     matchCreativeTemplateFromCreativeTemplateName(creativeTemplateName: string): string | number;
+    /**
+     * Return a fully-qualified creativeWrapper resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} creative_wrapper
+     * @returns {string} Resource name string.
+     */
+    creativeWrapperPath(networkCode: string, creativeWrapper: string): string;
+    /**
+     * Parse the network_code from CreativeWrapper resource.
+     *
+     * @param {string} creativeWrapperName
+     *   A fully-qualified path representing CreativeWrapper resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromCreativeWrapperName(creativeWrapperName: string): string | number;
+    /**
+     * Parse the creative_wrapper from CreativeWrapper resource.
+     *
+     * @param {string} creativeWrapperName
+     *   A fully-qualified path representing CreativeWrapper resource.
+     * @returns {string} A string representing the creative_wrapper.
+     */
+    matchCreativeWrapperFromCreativeWrapperName(creativeWrapperName: string): string | number;
     /**
      * Return a fully-qualified customField resource name string.
      *
@@ -855,6 +965,69 @@ export declare class NetworkServiceClient {
      * @returns {string} A string representing the custom_targeting_value.
      */
     matchCustomTargetingValueFromCustomTargetingValueName(customTargetingValueName: string): string | number;
+    /**
+     * Return a fully-qualified daiAuthenticationKey resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} dai_authentication_key
+     * @returns {string} Resource name string.
+     */
+    daiAuthenticationKeyPath(networkCode: string, daiAuthenticationKey: string): string;
+    /**
+     * Parse the network_code from DaiAuthenticationKey resource.
+     *
+     * @param {string} daiAuthenticationKeyName
+     *   A fully-qualified path representing DaiAuthenticationKey resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromDaiAuthenticationKeyName(daiAuthenticationKeyName: string): string | number;
+    /**
+     * Parse the dai_authentication_key from DaiAuthenticationKey resource.
+     *
+     * @param {string} daiAuthenticationKeyName
+     *   A fully-qualified path representing DaiAuthenticationKey resource.
+     * @returns {string} A string representing the dai_authentication_key.
+     */
+    matchDaiAuthenticationKeyFromDaiAuthenticationKeyName(daiAuthenticationKeyName: string): string | number;
+    /**
+     * Return a fully-qualified daiEncodingProfile resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} dai_encoding_profile
+     * @returns {string} Resource name string.
+     */
+    daiEncodingProfilePath(networkCode: string, daiEncodingProfile: string): string;
+    /**
+     * Parse the network_code from DaiEncodingProfile resource.
+     *
+     * @param {string} daiEncodingProfileName
+     *   A fully-qualified path representing DaiEncodingProfile resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromDaiEncodingProfileName(daiEncodingProfileName: string): string | number;
+    /**
+     * Parse the dai_encoding_profile from DaiEncodingProfile resource.
+     *
+     * @param {string} daiEncodingProfileName
+     *   A fully-qualified path representing DaiEncodingProfile resource.
+     * @returns {string} A string representing the dai_encoding_profile.
+     */
+    matchDaiEncodingProfileFromDaiEncodingProfileName(daiEncodingProfileName: string): string | number;
+    /**
+     * Return a fully-qualified defaultThirdPartyDataDeclaration resource name string.
+     *
+     * @param {string} network_code
+     * @returns {string} Resource name string.
+     */
+    defaultThirdPartyDataDeclarationPath(networkCode: string): string;
+    /**
+     * Parse the network_code from DefaultThirdPartyDataDeclaration resource.
+     *
+     * @param {string} defaultThirdPartyDataDeclarationName
+     *   A fully-qualified path representing DefaultThirdPartyDataDeclaration resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromDefaultThirdPartyDataDeclarationName(defaultThirdPartyDataDeclarationName: string): string | number;
     /**
      * Return a fully-qualified deviceCapability resource name string.
      *
@@ -1167,6 +1340,30 @@ export declare class NetworkServiceClient {
      * @returns {string} A string representing the mobile_device_submodel.
      */
     matchMobileDeviceSubmodelFromMobileDeviceSubmodelName(mobileDeviceSubmodelName: string): string | number;
+    /**
+     * Return a fully-qualified nativeStyle resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} native_style
+     * @returns {string} Resource name string.
+     */
+    nativeStylePath(networkCode: string, nativeStyle: string): string;
+    /**
+     * Parse the network_code from NativeStyle resource.
+     *
+     * @param {string} nativeStyleName
+     *   A fully-qualified path representing NativeStyle resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromNativeStyleName(nativeStyleName: string): string | number;
+    /**
+     * Parse the native_style from NativeStyle resource.
+     *
+     * @param {string} nativeStyleName
+     *   A fully-qualified path representing NativeStyle resource.
+     * @returns {string} A string representing the native_style.
+     */
+    matchNativeStyleFromNativeStyleName(nativeStyleName: string): string | number;
     /**
      * Return a fully-qualified network resource name string.
      *
@@ -1254,6 +1451,30 @@ export declare class NetworkServiceClient {
      * @returns {string} A string representing the order.
      */
     matchOrderFromOrderName(orderName: string): string | number;
+    /**
+     * Return a fully-qualified partner resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} partner
+     * @returns {string} Resource name string.
+     */
+    partnerPath(networkCode: string, partner: string): string;
+    /**
+     * Parse the network_code from Partner resource.
+     *
+     * @param {string} partnerName
+     *   A fully-qualified path representing Partner resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromPartnerName(partnerName: string): string | number;
+    /**
+     * Parse the partner from Partner resource.
+     *
+     * @param {string} partnerName
+     *   A fully-qualified path representing Partner resource.
+     * @returns {string} A string representing the partner.
+     */
+    matchPartnerFromPartnerName(partnerName: string): string | number;
     /**
      * Return a fully-qualified placement resource name string.
      *
@@ -1614,6 +1835,30 @@ export declare class NetworkServiceClient {
      * @returns {string} A string representing the user.
      */
     matchUserFromUserName(userName: string): string | number;
+    /**
+     * Return a fully-qualified viewabilityProvider resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} viewability_provider
+     * @returns {string} Resource name string.
+     */
+    viewabilityProviderPath(networkCode: string, viewabilityProvider: string): string;
+    /**
+     * Parse the network_code from ViewabilityProvider resource.
+     *
+     * @param {string} viewabilityProviderName
+     *   A fully-qualified path representing ViewabilityProvider resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromViewabilityProviderName(viewabilityProviderName: string): string | number;
+    /**
+     * Parse the viewability_provider from ViewabilityProvider resource.
+     *
+     * @param {string} viewabilityProviderName
+     *   A fully-qualified path representing ViewabilityProvider resource.
+     * @returns {string} A string representing the viewability_provider.
+     */
+    matchViewabilityProviderFromViewabilityProviderName(viewabilityProviderName: string): string | number;
     /**
      * Return a fully-qualified webProperty resource name string.
      *