@google-ads/admanager 0.9.0 → 0.11.0

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

@@ -670,31 +670,30 @@ export declare class OrderServiceClient {
      *    See syntax details at
      *    https://developers.google.com/ad-manager/api/beta/filters
      *
-     *   <b>Filterable fields:</b>
-     *   <ul style="list-style-type:none">
-     *     <li><code>advertiser</code></li>
-     *     <li><code>agency</code></li>
-     *     <li><code>appliedTeams</code></li>
-     *     <li><code>archived</code></li>
-     *     <li><code>creator</code></li>
-     *     <li><code>displayName</code></li>
-     *     <li><code>endTime</code></li>
-     *     <li><code>externalOrderId</code></li>
-     *     <li><code>impressionsDelivered</code></li>
-     *     <li><code>name</code></li>
-     *     <li><code>orderId</code></li>
-     *     <li><code>poNumber</code></li>
-     *     <li><code>programmatic</code></li>
-     *     <li><code>salesperson</code></li>
-     *     <li><code>secondarySalespeople</code></li>
-     *     <li><code>secondaryTraffickers</code></li>
-     *     <li><code>startTime</code></li>
-     *     <li><code>status</code></li>
-     *     <li><code>totalClicksDelivered</code></li>
-     *     <li><code>totalViewableImpressionsDelivered</code></li>
-     *     <li><code>trafficker</code></li>
-     *     <li><code>updateTime</code></li>
-     *   </ul>
+     *   **Filterable fields:**
+     *
+     *   * `advertiser`
+     *   * `agency`
+     *   * `appliedTeams`
+     *   * `archived`
+     *   * `creator`
+     *   * `displayName`
+     *   * `endTime`
+     *   * `externalOrderId`
+     *   * `impressionsDelivered`
+     *   * `name`
+     *   * `orderId`
+     *   * `poNumber`
+     *   * `programmatic`
+     *   * `salesperson`
+     *   * `secondarySalespeople`
+     *   * `secondaryTraffickers`
+     *   * `startTime`
+     *   * `status`
+     *   * `totalClicksDelivered`
+     *   * `totalViewableImpressionsDelivered`
+     *   * `trafficker`
+     *   * `updateTime`
      * @param {string} [request.orderBy]
      *   Optional. Expression to specify sorting order.
      *   See syntax details at
@@ -743,31 +742,30 @@ export declare class OrderServiceClient {
      *    See syntax details at
      *    https://developers.google.com/ad-manager/api/beta/filters
      *
-     *   <b>Filterable fields:</b>
-     *   <ul style="list-style-type:none">
-     *     <li><code>advertiser</code></li>
-     *     <li><code>agency</code></li>
-     *     <li><code>appliedTeams</code></li>
-     *     <li><code>archived</code></li>
-     *     <li><code>creator</code></li>
-     *     <li><code>displayName</code></li>
-     *     <li><code>endTime</code></li>
-     *     <li><code>externalOrderId</code></li>
-     *     <li><code>impressionsDelivered</code></li>
-     *     <li><code>name</code></li>
-     *     <li><code>orderId</code></li>
-     *     <li><code>poNumber</code></li>
-     *     <li><code>programmatic</code></li>
-     *     <li><code>salesperson</code></li>
-     *     <li><code>secondarySalespeople</code></li>
-     *     <li><code>secondaryTraffickers</code></li>
-     *     <li><code>startTime</code></li>
-     *     <li><code>status</code></li>
-     *     <li><code>totalClicksDelivered</code></li>
-     *     <li><code>totalViewableImpressionsDelivered</code></li>
-     *     <li><code>trafficker</code></li>
-     *     <li><code>updateTime</code></li>
-     *   </ul>
+     *   **Filterable fields:**
+     *
+     *   * `advertiser`
+     *   * `agency`
+     *   * `appliedTeams`
+     *   * `archived`
+     *   * `creator`
+     *   * `displayName`
+     *   * `endTime`
+     *   * `externalOrderId`
+     *   * `impressionsDelivered`
+     *   * `name`
+     *   * `orderId`
+     *   * `poNumber`
+     *   * `programmatic`
+     *   * `salesperson`
+     *   * `secondarySalespeople`
+     *   * `secondaryTraffickers`
+     *   * `startTime`
+     *   * `status`
+     *   * `totalClicksDelivered`
+     *   * `totalViewableImpressionsDelivered`
+     *   * `trafficker`
+     *   * `updateTime`
      * @param {string} [request.orderBy]
      *   Optional. Expression to specify sorting order.
      *   See syntax details at
@@ -811,31 +809,30 @@ export declare class OrderServiceClient {
      *    See syntax details at
      *    https://developers.google.com/ad-manager/api/beta/filters
      *
-     *   <b>Filterable fields:</b>
-     *   <ul style="list-style-type:none">
-     *     <li><code>advertiser</code></li>
-     *     <li><code>agency</code></li>
-     *     <li><code>appliedTeams</code></li>
-     *     <li><code>archived</code></li>
-     *     <li><code>creator</code></li>
-     *     <li><code>displayName</code></li>
-     *     <li><code>endTime</code></li>
-     *     <li><code>externalOrderId</code></li>
-     *     <li><code>impressionsDelivered</code></li>
-     *     <li><code>name</code></li>
-     *     <li><code>orderId</code></li>
-     *     <li><code>poNumber</code></li>
-     *     <li><code>programmatic</code></li>
-     *     <li><code>salesperson</code></li>
-     *     <li><code>secondarySalespeople</code></li>
-     *     <li><code>secondaryTraffickers</code></li>
-     *     <li><code>startTime</code></li>
-     *     <li><code>status</code></li>
-     *     <li><code>totalClicksDelivered</code></li>
-     *     <li><code>totalViewableImpressionsDelivered</code></li>
-     *     <li><code>trafficker</code></li>
-     *     <li><code>updateTime</code></li>
-     *   </ul>
+     *   **Filterable fields:**
+     *
+     *   * `advertiser`
+     *   * `agency`
+     *   * `appliedTeams`
+     *   * `archived`
+     *   * `creator`
+     *   * `displayName`
+     *   * `endTime`
+     *   * `externalOrderId`
+     *   * `impressionsDelivered`
+     *   * `name`
+     *   * `orderId`
+     *   * `poNumber`
+     *   * `programmatic`
+     *   * `salesperson`
+     *   * `secondarySalespeople`
+     *   * `secondaryTraffickers`
+     *   * `startTime`
+     *   * `status`
+     *   * `totalClicksDelivered`
+     *   * `totalViewableImpressionsDelivered`
+     *   * `trafficker`
+     *   * `updateTime`
      * @param {string} [request.orderBy]
      *   Optional. Expression to specify sorting order.
      *   See syntax details at
@@ -1401,6 +1398,30 @@ export declare class OrderServiceClient {
      * @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.
      *
@@ -1473,6 +1494,69 @@ export declare class OrderServiceClient {
      * @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.
      *
@@ -1785,6 +1869,30 @@ export declare class OrderServiceClient {
      * @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.
      *
@@ -1872,6 +1980,30 @@ export declare class OrderServiceClient {
      * @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.
      *
@@ -2232,6 +2364,30 @@ export declare class OrderServiceClient {
      * @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.
      *