@google-ads/admanager 0.8.0 → 0.10.0

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

@@ -163,43 +163,42 @@ export declare class LineItemServiceClient {
      *    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>archived</code></li>
-     *     <li><code>contractedUnitsBought</code></li>
-     *     <li><code>costType</code></li>
-     *     <li><code>createTime</code></li>
-     *     <li><code>creativePlaceholders.size.canonicalName</code></li>
-     *     <li><code>dealInfo.externalDealId</code></li>
-     *     <li><code>deliveryRateType</code></li>
-     *     <li><code>displayName</code></li>
-     *     <li><code>endTime</code></li>
-     *     <li><code>environmentType</code></li>
-     *     <li><code>externalLineItemId</code></li>
-     *     <li><code>goal.units</code></li>
-     *     <li><code>grpSettings.growbirdNielsenEnabled</code></li>
-     *     <li><code>grpSettings.inTargetRatioEstimateMilliPercent</code></li>
-     *     <li><code>lineItemType</code></li>
-     *     <li><code>missingCreatives</code></li>
-     *     <li><code>name</code></li>
-     *     <li><code>notes</code></li>
-     *     <li><code>order</code></li>
-     *     <li><code>orderDisplayName</code></li>
-     *     <li><code>priority</code></li>
-     *     <li><code>roadblockingType</code></li>
-     *     <li><code>startTime</code></li>
-     *     <li><code>stats.clickThroughRate</code></li>
-     *     <li><code>stats.clicksDelivered</code></li>
-     *     <li><code>stats.impressionsDelivered</code></li>
-     *     <li><code>stats.viewableImpressionsDelivered</code></li>
-     *     <li><code>status</code></li>
-     *     <li><code>targeting.inventoryTargeting.targetedAdUnits.adUnit</code></li>
-     *     <li><code>targeting.inventoryTargeting.targetedPlacements</code></li>
-     *     <li><code>targeting.mobileApplicationTargeting.firstPartyTargeting.targetedApplications</code></li>
-     *     <li><code>updateSource</code></li>
-     *     <li><code>updateTime</code></li>
-     *     <li><code>webPropertyCode</code></li>
-     *   </ul>
+     *   **Filterable fields:**
+     *
+     *   * `archived`
+     *   * `contractedUnitsBought`
+     *   * `costType`
+     *   * `createTime`
+     *   * `creativePlaceholders.size.canonicalName`
+     *   * `dealInfo.externalDealId`
+     *   * `deliveryRateType`
+     *   * `displayName`
+     *   * `endTime`
+     *   * `environmentType`
+     *   * `externalLineItemId`
+     *   * `goal.units`
+     *   * `grpSettings.growbirdNielsenEnabled`
+     *   * `grpSettings.inTargetRatioEstimateMilliPercent`
+     *   * `lineItemType`
+     *   * `missingCreatives`
+     *   * `name`
+     *   * `notes`
+     *   * `order`
+     *   * `orderDisplayName`
+     *   * `priority`
+     *   * `roadblockingType`
+     *   * `startTime`
+     *   * `stats.clickThroughRate`
+     *   * `stats.clicksDelivered`
+     *   * `stats.impressionsDelivered`
+     *   * `stats.viewableImpressionsDelivered`
+     *   * `status`
+     *   * `targeting.inventoryTargeting.targetedAdUnits.adUnit`
+     *   * `targeting.inventoryTargeting.targetedPlacements`
+     *   * `targeting.mobileApplicationTargeting.firstPartyTargeting.targetedApplications`
+     *   * `updateSource`
+     *   * `updateTime`
+     *   * `webPropertyCode`
      * @param {string} [request.orderBy]
      *   Optional. Expression to specify sorting order.
      *   See syntax details at
@@ -248,43 +247,42 @@ export declare class LineItemServiceClient {
      *    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>archived</code></li>
-     *     <li><code>contractedUnitsBought</code></li>
-     *     <li><code>costType</code></li>
-     *     <li><code>createTime</code></li>
-     *     <li><code>creativePlaceholders.size.canonicalName</code></li>
-     *     <li><code>dealInfo.externalDealId</code></li>
-     *     <li><code>deliveryRateType</code></li>
-     *     <li><code>displayName</code></li>
-     *     <li><code>endTime</code></li>
-     *     <li><code>environmentType</code></li>
-     *     <li><code>externalLineItemId</code></li>
-     *     <li><code>goal.units</code></li>
-     *     <li><code>grpSettings.growbirdNielsenEnabled</code></li>
-     *     <li><code>grpSettings.inTargetRatioEstimateMilliPercent</code></li>
-     *     <li><code>lineItemType</code></li>
-     *     <li><code>missingCreatives</code></li>
-     *     <li><code>name</code></li>
-     *     <li><code>notes</code></li>
-     *     <li><code>order</code></li>
-     *     <li><code>orderDisplayName</code></li>
-     *     <li><code>priority</code></li>
-     *     <li><code>roadblockingType</code></li>
-     *     <li><code>startTime</code></li>
-     *     <li><code>stats.clickThroughRate</code></li>
-     *     <li><code>stats.clicksDelivered</code></li>
-     *     <li><code>stats.impressionsDelivered</code></li>
-     *     <li><code>stats.viewableImpressionsDelivered</code></li>
-     *     <li><code>status</code></li>
-     *     <li><code>targeting.inventoryTargeting.targetedAdUnits.adUnit</code></li>
-     *     <li><code>targeting.inventoryTargeting.targetedPlacements</code></li>
-     *     <li><code>targeting.mobileApplicationTargeting.firstPartyTargeting.targetedApplications</code></li>
-     *     <li><code>updateSource</code></li>
-     *     <li><code>updateTime</code></li>
-     *     <li><code>webPropertyCode</code></li>
-     *   </ul>
+     *   **Filterable fields:**
+     *
+     *   * `archived`
+     *   * `contractedUnitsBought`
+     *   * `costType`
+     *   * `createTime`
+     *   * `creativePlaceholders.size.canonicalName`
+     *   * `dealInfo.externalDealId`
+     *   * `deliveryRateType`
+     *   * `displayName`
+     *   * `endTime`
+     *   * `environmentType`
+     *   * `externalLineItemId`
+     *   * `goal.units`
+     *   * `grpSettings.growbirdNielsenEnabled`
+     *   * `grpSettings.inTargetRatioEstimateMilliPercent`
+     *   * `lineItemType`
+     *   * `missingCreatives`
+     *   * `name`
+     *   * `notes`
+     *   * `order`
+     *   * `orderDisplayName`
+     *   * `priority`
+     *   * `roadblockingType`
+     *   * `startTime`
+     *   * `stats.clickThroughRate`
+     *   * `stats.clicksDelivered`
+     *   * `stats.impressionsDelivered`
+     *   * `stats.viewableImpressionsDelivered`
+     *   * `status`
+     *   * `targeting.inventoryTargeting.targetedAdUnits.adUnit`
+     *   * `targeting.inventoryTargeting.targetedPlacements`
+     *   * `targeting.mobileApplicationTargeting.firstPartyTargeting.targetedApplications`
+     *   * `updateSource`
+     *   * `updateTime`
+     *   * `webPropertyCode`
      * @param {string} [request.orderBy]
      *   Optional. Expression to specify sorting order.
      *   See syntax details at
@@ -328,43 +326,42 @@ export declare class LineItemServiceClient {
      *    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>archived</code></li>
-     *     <li><code>contractedUnitsBought</code></li>
-     *     <li><code>costType</code></li>
-     *     <li><code>createTime</code></li>
-     *     <li><code>creativePlaceholders.size.canonicalName</code></li>
-     *     <li><code>dealInfo.externalDealId</code></li>
-     *     <li><code>deliveryRateType</code></li>
-     *     <li><code>displayName</code></li>
-     *     <li><code>endTime</code></li>
-     *     <li><code>environmentType</code></li>
-     *     <li><code>externalLineItemId</code></li>
-     *     <li><code>goal.units</code></li>
-     *     <li><code>grpSettings.growbirdNielsenEnabled</code></li>
-     *     <li><code>grpSettings.inTargetRatioEstimateMilliPercent</code></li>
-     *     <li><code>lineItemType</code></li>
-     *     <li><code>missingCreatives</code></li>
-     *     <li><code>name</code></li>
-     *     <li><code>notes</code></li>
-     *     <li><code>order</code></li>
-     *     <li><code>orderDisplayName</code></li>
-     *     <li><code>priority</code></li>
-     *     <li><code>roadblockingType</code></li>
-     *     <li><code>startTime</code></li>
-     *     <li><code>stats.clickThroughRate</code></li>
-     *     <li><code>stats.clicksDelivered</code></li>
-     *     <li><code>stats.impressionsDelivered</code></li>
-     *     <li><code>stats.viewableImpressionsDelivered</code></li>
-     *     <li><code>status</code></li>
-     *     <li><code>targeting.inventoryTargeting.targetedAdUnits.adUnit</code></li>
-     *     <li><code>targeting.inventoryTargeting.targetedPlacements</code></li>
-     *     <li><code>targeting.mobileApplicationTargeting.firstPartyTargeting.targetedApplications</code></li>
-     *     <li><code>updateSource</code></li>
-     *     <li><code>updateTime</code></li>
-     *     <li><code>webPropertyCode</code></li>
-     *   </ul>
+     *   **Filterable fields:**
+     *
+     *   * `archived`
+     *   * `contractedUnitsBought`
+     *   * `costType`
+     *   * `createTime`
+     *   * `creativePlaceholders.size.canonicalName`
+     *   * `dealInfo.externalDealId`
+     *   * `deliveryRateType`
+     *   * `displayName`
+     *   * `endTime`
+     *   * `environmentType`
+     *   * `externalLineItemId`
+     *   * `goal.units`
+     *   * `grpSettings.growbirdNielsenEnabled`
+     *   * `grpSettings.inTargetRatioEstimateMilliPercent`
+     *   * `lineItemType`
+     *   * `missingCreatives`
+     *   * `name`
+     *   * `notes`
+     *   * `order`
+     *   * `orderDisplayName`
+     *   * `priority`
+     *   * `roadblockingType`
+     *   * `startTime`
+     *   * `stats.clickThroughRate`
+     *   * `stats.clicksDelivered`
+     *   * `stats.impressionsDelivered`
+     *   * `stats.viewableImpressionsDelivered`
+     *   * `status`
+     *   * `targeting.inventoryTargeting.targetedAdUnits.adUnit`
+     *   * `targeting.inventoryTargeting.targetedPlacements`
+     *   * `targeting.mobileApplicationTargeting.firstPartyTargeting.targetedApplications`
+     *   * `updateSource`
+     *   * `updateTime`
+     *   * `webPropertyCode`
      * @param {string} [request.orderBy]
      *   Optional. Expression to specify sorting order.
      *   See syntax details at
@@ -930,6 +927,30 @@ export declare class LineItemServiceClient {
      * @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.
      *
@@ -1002,6 +1023,54 @@ export declare class LineItemServiceClient {
      * @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 deviceCapability resource name string.
      *
@@ -1401,6 +1470,30 @@ export declare class LineItemServiceClient {
      * @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.
      *
@@ -1761,6 +1854,30 @@ export declare class LineItemServiceClient {
      * @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.
      *