From f6b1a8e2d291c2ac9d2ea590101bb3c8c6fbe6cf Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Fri, 4 Jun 2021 07:37:58 +0000 Subject: [PATCH] feat(displayvideo): update the api #### displayvideo:v1 The following keys were deleted: - schemas.BudgetSummary.properties.externalBudgetId.readOnly (Total Keys: 1) - schemas.BudgetSummary.properties.preTaxAmountMicros.readOnly (Total Keys: 1) - schemas.BudgetSummary.properties.prismaCpeCode.readOnly (Total Keys: 1) - schemas.BudgetSummary.properties.taxAmountMicros.readOnly (Total Keys: 1) - schemas.BudgetSummary.properties.totalAmountMicros.readOnly (Total Keys: 1) - schemas.Invoice.properties.budgetInvoiceGroupingId.readOnly (Total Keys: 1) - schemas.Invoice.properties.budgetSummaries.readOnly (Total Keys: 1) - schemas.Invoice.properties.correctedInvoiceId.readOnly (Total Keys: 1) - schemas.Invoice.properties.currencyCode.readOnly (Total Keys: 1) - schemas.Invoice.properties.displayName.readOnly (Total Keys: 1) - schemas.Invoice.properties.dueDate.readOnly (Total Keys: 1) - schemas.Invoice.properties.invoiceId.readOnly (Total Keys: 1) - schemas.Invoice.properties.invoiceType.readOnly (Total Keys: 1) - schemas.Invoice.properties.issueDate.readOnly (Total Keys: 1) - schemas.Invoice.properties.name.readOnly (Total Keys: 1) - schemas.Invoice.properties.nonBudgetMicros.readOnly (Total Keys: 1) - schemas.Invoice.properties.paymentsAccountId.readOnly (Total Keys: 1) - schemas.Invoice.properties.paymentsProfileId.readOnly (Total Keys: 1) - schemas.Invoice.properties.purchaseOrderNumber.readOnly (Total Keys: 1) - schemas.Invoice.properties.replacedInvoiceIds.readOnly (Total Keys: 1) - schemas.Invoice.properties.serviceDateRange.readOnly (Total Keys: 1) - schemas.Invoice.properties.subtotalAmountMicros.readOnly (Total Keys: 1) - schemas.Invoice.properties.totalAmountMicros.readOnly (Total Keys: 1) - schemas.Invoice.properties.totalTaxAmountMicros.readOnly (Total Keys: 1) - schemas.LookupInvoiceCurrencyResponse.properties.currencyCode.readOnly (Total Keys: 1) --- ...displayvideo_v1.advertisers.campaigns.html | 120 ++++++++-------- docs/dyn/displayvideo_v1.advertisers.html | 12 +- ...yvideo_v1.advertisers.insertionOrders.html | 12 +- .../displayvideo_v1.advertisers.invoices.html | 78 +++++------ .../documents/displayvideo.v1.json | 132 +++++++----------- 5 files changed, 163 insertions(+), 191 deletions(-) diff --git a/docs/dyn/displayvideo_v1.advertisers.campaigns.html b/docs/dyn/displayvideo_v1.advertisers.campaigns.html index f4b8dd3a9cc..404913e479a 100644 --- a/docs/dyn/displayvideo_v1.advertisers.campaigns.html +++ b/docs/dyn/displayvideo_v1.advertisers.campaigns.html @@ -429,12 +429,12 @@

Method Details

{ # A single campaign. "advertiserId": "A String", # Output only. The unique ID of the advertiser the campaign belongs to. - "campaignBudgets": [ # The list of budgets available to this campaign. Setting no budget gives an unlimited campaign budget. + "campaignBudgets": [ # The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget. { # Settings that control how the campaign budget is allocated. - "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "budgetId": "A String", # The unique ID of the campaign budget. If not included, budget is assumed to be new. - "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. - "dateRange": { # A date range. # Required. The flight start and end time settings of the segment. Both `start_date` and `end_date` must be before the year 2037. + "budgetAmountMicros": "A String", # Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. + "budgetId": "A String", # The unique ID of the campaign budget. Assigned by the system. Do not set for new budgets. Must be included when updating or adding budgets to campaign_budgets. Otherwise, a new ID will be generated and assigned. + "budgetUnit": "A String", # Required. Immutable. Specifies whether the budget is measured in currency or impressions. + "dateRange": { # A date range. # Required. The date range for the campaign budget. Linked budget segments may have a different date range. They are resolved relative to the parent advertiser's time zone. Both `start_date` and `end_date` must be before the year 2037. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. @@ -447,11 +447,11 @@

Method Details

}, }, "displayName": "A String", # Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes. - "externalBudgetId": "A String", # Immutable. Must be unique under the campaign. If set, all impressions served against this budget will include this ID on the invoice if the customer has opted into budget-segment-level billing. - "externalBudgetSource": "A String", # Required. The external source of the budget segment. - "invoiceGroupingId": "A String", # Immutable. If set, all external_budget_id sharing the same invoice_grouping_id will include this ID on the invoice if the customer has opted into budget-segment-level billing. - "prismaConfig": { # Settings specific to the MediaOcean Prisma tool. # Required for MediaOcean budgets. Additional metadata set by the MediaOcean Prisma tool. - "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Required. Google Payments Center supports searching and filtering on this code. + "externalBudgetId": "A String", # Immutable. The ID identifying this budget to the external source. If this field is set and the invoice detail level of the corresponding billing profile is set to "Budget level PO", all impressions served against this budget will include this ID on the invoice. Must be unique under the campaign. + "externalBudgetSource": "A String", # Required. The external source of the budget. + "invoiceGroupingId": "A String", # Immutable. The ID used to group budgets to be included the same invoice. If this field is set and the invoice level of the corresponding billing profile is set to "Budget invoice grouping ID", all external_budget_id sharing the same invoice_grouping_id will be grouped in the same invoice. + "prismaConfig": { # Settings specific to the Mediaocean Prisma tool. # Additional metadata for use by the Mediaocean Prisma tool. Required for Mediaocean budgets. Only applicable to prisma_enabled advertisers. + "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Required. Relevant client, product, and estimate codes from the Mediaocean Prisma tool. "prismaClientCode": "A String", # The Prisma client code. "prismaEstimateCode": "A String", # The Prisma estimate code. "prismaProductCode": "A String", # The Prisma product code. @@ -508,12 +508,12 @@

Method Details

{ # A single campaign. "advertiserId": "A String", # Output only. The unique ID of the advertiser the campaign belongs to. - "campaignBudgets": [ # The list of budgets available to this campaign. Setting no budget gives an unlimited campaign budget. + "campaignBudgets": [ # The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget. { # Settings that control how the campaign budget is allocated. - "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "budgetId": "A String", # The unique ID of the campaign budget. If not included, budget is assumed to be new. - "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. - "dateRange": { # A date range. # Required. The flight start and end time settings of the segment. Both `start_date` and `end_date` must be before the year 2037. + "budgetAmountMicros": "A String", # Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. + "budgetId": "A String", # The unique ID of the campaign budget. Assigned by the system. Do not set for new budgets. Must be included when updating or adding budgets to campaign_budgets. Otherwise, a new ID will be generated and assigned. + "budgetUnit": "A String", # Required. Immutable. Specifies whether the budget is measured in currency or impressions. + "dateRange": { # A date range. # Required. The date range for the campaign budget. Linked budget segments may have a different date range. They are resolved relative to the parent advertiser's time zone. Both `start_date` and `end_date` must be before the year 2037. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. @@ -526,11 +526,11 @@

Method Details

}, }, "displayName": "A String", # Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes. - "externalBudgetId": "A String", # Immutable. Must be unique under the campaign. If set, all impressions served against this budget will include this ID on the invoice if the customer has opted into budget-segment-level billing. - "externalBudgetSource": "A String", # Required. The external source of the budget segment. - "invoiceGroupingId": "A String", # Immutable. If set, all external_budget_id sharing the same invoice_grouping_id will include this ID on the invoice if the customer has opted into budget-segment-level billing. - "prismaConfig": { # Settings specific to the MediaOcean Prisma tool. # Required for MediaOcean budgets. Additional metadata set by the MediaOcean Prisma tool. - "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Required. Google Payments Center supports searching and filtering on this code. + "externalBudgetId": "A String", # Immutable. The ID identifying this budget to the external source. If this field is set and the invoice detail level of the corresponding billing profile is set to "Budget level PO", all impressions served against this budget will include this ID on the invoice. Must be unique under the campaign. + "externalBudgetSource": "A String", # Required. The external source of the budget. + "invoiceGroupingId": "A String", # Immutable. The ID used to group budgets to be included the same invoice. If this field is set and the invoice level of the corresponding billing profile is set to "Budget invoice grouping ID", all external_budget_id sharing the same invoice_grouping_id will be grouped in the same invoice. + "prismaConfig": { # Settings specific to the Mediaocean Prisma tool. # Additional metadata for use by the Mediaocean Prisma tool. Required for Mediaocean budgets. Only applicable to prisma_enabled advertisers. + "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Required. Relevant client, product, and estimate codes from the Mediaocean Prisma tool. "prismaClientCode": "A String", # The Prisma client code. "prismaEstimateCode": "A String", # The Prisma estimate code. "prismaProductCode": "A String", # The Prisma product code. @@ -614,12 +614,12 @@

Method Details

{ # A single campaign. "advertiserId": "A String", # Output only. The unique ID of the advertiser the campaign belongs to. - "campaignBudgets": [ # The list of budgets available to this campaign. Setting no budget gives an unlimited campaign budget. + "campaignBudgets": [ # The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget. { # Settings that control how the campaign budget is allocated. - "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "budgetId": "A String", # The unique ID of the campaign budget. If not included, budget is assumed to be new. - "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. - "dateRange": { # A date range. # Required. The flight start and end time settings of the segment. Both `start_date` and `end_date` must be before the year 2037. + "budgetAmountMicros": "A String", # Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. + "budgetId": "A String", # The unique ID of the campaign budget. Assigned by the system. Do not set for new budgets. Must be included when updating or adding budgets to campaign_budgets. Otherwise, a new ID will be generated and assigned. + "budgetUnit": "A String", # Required. Immutable. Specifies whether the budget is measured in currency or impressions. + "dateRange": { # A date range. # Required. The date range for the campaign budget. Linked budget segments may have a different date range. They are resolved relative to the parent advertiser's time zone. Both `start_date` and `end_date` must be before the year 2037. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. @@ -632,11 +632,11 @@

Method Details

}, }, "displayName": "A String", # Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes. - "externalBudgetId": "A String", # Immutable. Must be unique under the campaign. If set, all impressions served against this budget will include this ID on the invoice if the customer has opted into budget-segment-level billing. - "externalBudgetSource": "A String", # Required. The external source of the budget segment. - "invoiceGroupingId": "A String", # Immutable. If set, all external_budget_id sharing the same invoice_grouping_id will include this ID on the invoice if the customer has opted into budget-segment-level billing. - "prismaConfig": { # Settings specific to the MediaOcean Prisma tool. # Required for MediaOcean budgets. Additional metadata set by the MediaOcean Prisma tool. - "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Required. Google Payments Center supports searching and filtering on this code. + "externalBudgetId": "A String", # Immutable. The ID identifying this budget to the external source. If this field is set and the invoice detail level of the corresponding billing profile is set to "Budget level PO", all impressions served against this budget will include this ID on the invoice. Must be unique under the campaign. + "externalBudgetSource": "A String", # Required. The external source of the budget. + "invoiceGroupingId": "A String", # Immutable. The ID used to group budgets to be included the same invoice. If this field is set and the invoice level of the corresponding billing profile is set to "Budget invoice grouping ID", all external_budget_id sharing the same invoice_grouping_id will be grouped in the same invoice. + "prismaConfig": { # Settings specific to the Mediaocean Prisma tool. # Additional metadata for use by the Mediaocean Prisma tool. Required for Mediaocean budgets. Only applicable to prisma_enabled advertisers. + "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Required. Relevant client, product, and estimate codes from the Mediaocean Prisma tool. "prismaClientCode": "A String", # The Prisma client code. "prismaEstimateCode": "A String", # The Prisma estimate code. "prismaProductCode": "A String", # The Prisma product code. @@ -706,12 +706,12 @@

Method Details

"campaigns": [ # The list of campaigns. This list will be absent if empty. { # A single campaign. "advertiserId": "A String", # Output only. The unique ID of the advertiser the campaign belongs to. - "campaignBudgets": [ # The list of budgets available to this campaign. Setting no budget gives an unlimited campaign budget. + "campaignBudgets": [ # The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget. { # Settings that control how the campaign budget is allocated. - "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "budgetId": "A String", # The unique ID of the campaign budget. If not included, budget is assumed to be new. - "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. - "dateRange": { # A date range. # Required. The flight start and end time settings of the segment. Both `start_date` and `end_date` must be before the year 2037. + "budgetAmountMicros": "A String", # Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. + "budgetId": "A String", # The unique ID of the campaign budget. Assigned by the system. Do not set for new budgets. Must be included when updating or adding budgets to campaign_budgets. Otherwise, a new ID will be generated and assigned. + "budgetUnit": "A String", # Required. Immutable. Specifies whether the budget is measured in currency or impressions. + "dateRange": { # A date range. # Required. The date range for the campaign budget. Linked budget segments may have a different date range. They are resolved relative to the parent advertiser's time zone. Both `start_date` and `end_date` must be before the year 2037. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. @@ -724,11 +724,11 @@

Method Details

}, }, "displayName": "A String", # Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes. - "externalBudgetId": "A String", # Immutable. Must be unique under the campaign. If set, all impressions served against this budget will include this ID on the invoice if the customer has opted into budget-segment-level billing. - "externalBudgetSource": "A String", # Required. The external source of the budget segment. - "invoiceGroupingId": "A String", # Immutable. If set, all external_budget_id sharing the same invoice_grouping_id will include this ID on the invoice if the customer has opted into budget-segment-level billing. - "prismaConfig": { # Settings specific to the MediaOcean Prisma tool. # Required for MediaOcean budgets. Additional metadata set by the MediaOcean Prisma tool. - "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Required. Google Payments Center supports searching and filtering on this code. + "externalBudgetId": "A String", # Immutable. The ID identifying this budget to the external source. If this field is set and the invoice detail level of the corresponding billing profile is set to "Budget level PO", all impressions served against this budget will include this ID on the invoice. Must be unique under the campaign. + "externalBudgetSource": "A String", # Required. The external source of the budget. + "invoiceGroupingId": "A String", # Immutable. The ID used to group budgets to be included the same invoice. If this field is set and the invoice level of the corresponding billing profile is set to "Budget invoice grouping ID", all external_budget_id sharing the same invoice_grouping_id will be grouped in the same invoice. + "prismaConfig": { # Settings specific to the Mediaocean Prisma tool. # Additional metadata for use by the Mediaocean Prisma tool. Required for Mediaocean budgets. Only applicable to prisma_enabled advertisers. + "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Required. Relevant client, product, and estimate codes from the Mediaocean Prisma tool. "prismaClientCode": "A String", # The Prisma client code. "prismaEstimateCode": "A String", # The Prisma estimate code. "prismaProductCode": "A String", # The Prisma product code. @@ -805,12 +805,12 @@

Method Details

{ # A single campaign. "advertiserId": "A String", # Output only. The unique ID of the advertiser the campaign belongs to. - "campaignBudgets": [ # The list of budgets available to this campaign. Setting no budget gives an unlimited campaign budget. + "campaignBudgets": [ # The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget. { # Settings that control how the campaign budget is allocated. - "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "budgetId": "A String", # The unique ID of the campaign budget. If not included, budget is assumed to be new. - "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. - "dateRange": { # A date range. # Required. The flight start and end time settings of the segment. Both `start_date` and `end_date` must be before the year 2037. + "budgetAmountMicros": "A String", # Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. + "budgetId": "A String", # The unique ID of the campaign budget. Assigned by the system. Do not set for new budgets. Must be included when updating or adding budgets to campaign_budgets. Otherwise, a new ID will be generated and assigned. + "budgetUnit": "A String", # Required. Immutable. Specifies whether the budget is measured in currency or impressions. + "dateRange": { # A date range. # Required. The date range for the campaign budget. Linked budget segments may have a different date range. They are resolved relative to the parent advertiser's time zone. Both `start_date` and `end_date` must be before the year 2037. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. @@ -823,11 +823,11 @@

Method Details

}, }, "displayName": "A String", # Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes. - "externalBudgetId": "A String", # Immutable. Must be unique under the campaign. If set, all impressions served against this budget will include this ID on the invoice if the customer has opted into budget-segment-level billing. - "externalBudgetSource": "A String", # Required. The external source of the budget segment. - "invoiceGroupingId": "A String", # Immutable. If set, all external_budget_id sharing the same invoice_grouping_id will include this ID on the invoice if the customer has opted into budget-segment-level billing. - "prismaConfig": { # Settings specific to the MediaOcean Prisma tool. # Required for MediaOcean budgets. Additional metadata set by the MediaOcean Prisma tool. - "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Required. Google Payments Center supports searching and filtering on this code. + "externalBudgetId": "A String", # Immutable. The ID identifying this budget to the external source. If this field is set and the invoice detail level of the corresponding billing profile is set to "Budget level PO", all impressions served against this budget will include this ID on the invoice. Must be unique under the campaign. + "externalBudgetSource": "A String", # Required. The external source of the budget. + "invoiceGroupingId": "A String", # Immutable. The ID used to group budgets to be included the same invoice. If this field is set and the invoice level of the corresponding billing profile is set to "Budget invoice grouping ID", all external_budget_id sharing the same invoice_grouping_id will be grouped in the same invoice. + "prismaConfig": { # Settings specific to the Mediaocean Prisma tool. # Additional metadata for use by the Mediaocean Prisma tool. Required for Mediaocean budgets. Only applicable to prisma_enabled advertisers. + "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Required. Relevant client, product, and estimate codes from the Mediaocean Prisma tool. "prismaClientCode": "A String", # The Prisma client code. "prismaEstimateCode": "A String", # The Prisma estimate code. "prismaProductCode": "A String", # The Prisma product code. @@ -885,12 +885,12 @@

Method Details

{ # A single campaign. "advertiserId": "A String", # Output only. The unique ID of the advertiser the campaign belongs to. - "campaignBudgets": [ # The list of budgets available to this campaign. Setting no budget gives an unlimited campaign budget. + "campaignBudgets": [ # The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget. { # Settings that control how the campaign budget is allocated. - "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "budgetId": "A String", # The unique ID of the campaign budget. If not included, budget is assumed to be new. - "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. - "dateRange": { # A date range. # Required. The flight start and end time settings of the segment. Both `start_date` and `end_date` must be before the year 2037. + "budgetAmountMicros": "A String", # Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. + "budgetId": "A String", # The unique ID of the campaign budget. Assigned by the system. Do not set for new budgets. Must be included when updating or adding budgets to campaign_budgets. Otherwise, a new ID will be generated and assigned. + "budgetUnit": "A String", # Required. Immutable. Specifies whether the budget is measured in currency or impressions. + "dateRange": { # A date range. # Required. The date range for the campaign budget. Linked budget segments may have a different date range. They are resolved relative to the parent advertiser's time zone. Both `start_date` and `end_date` must be before the year 2037. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. @@ -903,11 +903,11 @@

Method Details

}, }, "displayName": "A String", # Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes. - "externalBudgetId": "A String", # Immutable. Must be unique under the campaign. If set, all impressions served against this budget will include this ID on the invoice if the customer has opted into budget-segment-level billing. - "externalBudgetSource": "A String", # Required. The external source of the budget segment. - "invoiceGroupingId": "A String", # Immutable. If set, all external_budget_id sharing the same invoice_grouping_id will include this ID on the invoice if the customer has opted into budget-segment-level billing. - "prismaConfig": { # Settings specific to the MediaOcean Prisma tool. # Required for MediaOcean budgets. Additional metadata set by the MediaOcean Prisma tool. - "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Required. Google Payments Center supports searching and filtering on this code. + "externalBudgetId": "A String", # Immutable. The ID identifying this budget to the external source. If this field is set and the invoice detail level of the corresponding billing profile is set to "Budget level PO", all impressions served against this budget will include this ID on the invoice. Must be unique under the campaign. + "externalBudgetSource": "A String", # Required. The external source of the budget. + "invoiceGroupingId": "A String", # Immutable. The ID used to group budgets to be included the same invoice. If this field is set and the invoice level of the corresponding billing profile is set to "Budget invoice grouping ID", all external_budget_id sharing the same invoice_grouping_id will be grouped in the same invoice. + "prismaConfig": { # Settings specific to the Mediaocean Prisma tool. # Additional metadata for use by the Mediaocean Prisma tool. Required for Mediaocean budgets. Only applicable to prisma_enabled advertisers. + "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Required. Relevant client, product, and estimate codes from the Mediaocean Prisma tool. "prismaClientCode": "A String", # The Prisma client code. "prismaEstimateCode": "A String", # The Prisma estimate code. "prismaProductCode": "A String", # The Prisma product code. diff --git a/docs/dyn/displayvideo_v1.advertisers.html b/docs/dyn/displayvideo_v1.advertisers.html index fad2ed34ca1..f1a684733d5 100644 --- a/docs/dyn/displayvideo_v1.advertisers.html +++ b/docs/dyn/displayvideo_v1.advertisers.html @@ -1126,7 +1126,7 @@

Method Details

}, "name": "A String", # Output only. The resource name of the advertiser. "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to. - "prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser. + "prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser. "servingConfig": { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser. "exemptTvFromViewabilityTargeting": True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser. }, @@ -1186,7 +1186,7 @@

Method Details

}, "name": "A String", # Output only. The resource name of the advertiser. "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to. - "prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser. + "prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser. "servingConfig": { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser. "exemptTvFromViewabilityTargeting": True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser. }, @@ -1271,7 +1271,7 @@

Method Details

}, "name": "A String", # Output only. The resource name of the advertiser. "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to. - "prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser. + "prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser. "servingConfig": { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser. "exemptTvFromViewabilityTargeting": True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser. }, @@ -1344,7 +1344,7 @@

Method Details

}, "name": "A String", # Output only. The resource name of the advertiser. "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to. - "prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser. + "prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser. "servingConfig": { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser. "exemptTvFromViewabilityTargeting": True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser. }, @@ -1423,7 +1423,7 @@

Method Details

}, "name": "A String", # Output only. The resource name of the advertiser. "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to. - "prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser. + "prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser. "servingConfig": { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser. "exemptTvFromViewabilityTargeting": True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser. }, @@ -1484,7 +1484,7 @@

Method Details

}, "name": "A String", # Output only. The resource name of the advertiser. "partnerId": "A String", # Required. Immutable. The unique ID of the partner that the advertiser belongs to. - "prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser. + "prismaEnabled": True or False, # Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser. "servingConfig": { # Targeting settings related to ad serving of an advertiser. # Targeting settings related to ad serving of the advertiser. "exemptTvFromViewabilityTargeting": True or False, # Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser. }, diff --git a/docs/dyn/displayvideo_v1.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v1.advertisers.insertionOrders.html index 963c8a076ed..eff5006ad1a 100644 --- a/docs/dyn/displayvideo_v1.advertisers.insertionOrders.html +++ b/docs/dyn/displayvideo_v1.advertisers.insertionOrders.html @@ -450,7 +450,7 @@

Method Details

"budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. { # Settings that control the budget of a single budget segment. "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget segment. + "campaignBudgetId": "A String", # The budget_id of the campaign budget that this insertion order budget segment is a part of. "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -539,7 +539,7 @@

Method Details

"budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. { # Settings that control the budget of a single budget segment. "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget segment. + "campaignBudgetId": "A String", # The budget_id of the campaign budget that this insertion order budget segment is a part of. "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -655,7 +655,7 @@

Method Details

"budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. { # Settings that control the budget of a single budget segment. "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget segment. + "campaignBudgetId": "A String", # The budget_id of the campaign budget that this insertion order budget segment is a part of. "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -757,7 +757,7 @@

Method Details

"budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. { # Settings that control the budget of a single budget segment. "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget segment. + "campaignBudgetId": "A String", # The budget_id of the campaign budget that this insertion order budget segment is a part of. "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -866,7 +866,7 @@

Method Details

"budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. { # Settings that control the budget of a single budget segment. "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget segment. + "campaignBudgetId": "A String", # The budget_id of the campaign budget that this insertion order budget segment is a part of. "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -956,7 +956,7 @@

Method Details

"budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. { # Settings that control the budget of a single budget segment. "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget segment. + "campaignBudgetId": "A String", # The budget_id of the campaign budget that this insertion order budget segment is a part of. "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved relative to the parent advertiser's time zone. * When creating a new budget segment, both `start_date` and `end_date` must be in the future. * An existing budget segment with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. diff --git a/docs/dyn/displayvideo_v1.advertisers.invoices.html b/docs/dyn/displayvideo_v1.advertisers.invoices.html index d0fb7a81617..cd160e031b8 100644 --- a/docs/dyn/displayvideo_v1.advertisers.invoices.html +++ b/docs/dyn/displayvideo_v1.advertisers.invoices.html @@ -79,13 +79,13 @@

Instance Methods

Close httplib2 connections.

list(advertiserId, issueMonth=None, loiSapinInvoiceType=None, pageSize=None, pageToken=None, x__xgafv=None)

-

List invoices for an advertiser.

+

Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a "Partner" invoice level are not retrievable through this method.

list_next(previous_request, previous_response)

Retrieves the next page of results.

lookupInvoiceCurrency(advertiserId, invoiceMonth=None, x__xgafv=None)

-

Lookup invoice currency for an advertiser.

+

Retrieves the invoice currency used by an advertiser in a given month.

Method Details

close() @@ -94,18 +94,18 @@

Method Details

list(advertiserId, issueMonth=None, loiSapinInvoiceType=None, pageSize=None, pageToken=None, x__xgafv=None) - 
List invoices for an advertiser.
+  
Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a "Partner" invoice level are not retrievable through this method.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser to list invoices for. (required)
-  issueMonth: string, Required. Month for which invoices are needed in the format YYYYMM.
-  loiSapinInvoiceType: string, Select type of invoice to query for Loi Sapin advertisers. Otherwise its ignored.
+  issueMonth: string, The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM.
+  loiSapinInvoiceType: string, Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.
     Allowed values
       LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED - Value is not specified.
       LOI_SAPIN_INVOICE_TYPE_MEDIA - Invoices with Media cost.
       LOI_SAPIN_INVOICE_TYPE_PLATFORM - Invoices with Platform fee.
   pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
-  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of [ListInvoicesResponse.next_page_token] returned from the previous call to `ListInvoice` method. If not specified, the first page of results will be returned.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInvoices` method. If not specified, the first page of results will be returned.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -114,48 +114,48 @@ 
Method Details

 Returns:
   An object of the form:
 
-    { # Response message for InvoiceService.ListInvoices.
+    {
   "invoices": [ # The list of invoices. This list will be absent if empty.
-    { # A single Invoice.
-      "budgetInvoiceGroupingId": "A String", # Output only. Budget invoice grouping ID associated with the budget segment in the insertion order.
-      "budgetSummaries": [ # Output only. The list of summarized budget information associated with this invoice.
-        { # Represents a summarized budget information associated with this invoice.
-          "externalBudgetId": "A String", # Output only. External budget id.
-          "preTaxAmountMicros": "A String", # Output only. The pre-tax amount for this budget, in micros of the invoice's currency. For example if currency_code is `USD`, then 1000000 micros is one US dollar.
-          "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Output only. Codes specific to the MediaOcean Prisma tool.
+    { # A single invoice.
+      "budgetInvoiceGroupingId": "A String", # The budget grouping ID for this invoice. This field will only be set if the invoice level of the corresponding billing profile was set to "Budget invoice grouping ID".
+      "budgetSummaries": [ # The list of summarized information for each budget associated with this invoice. This field will only be set if the invoice detail level of the corresponding billing profile was set to "Budget level PO".
+        { # Summarized information of an individual campaign budget.
+          "externalBudgetId": "A String", # Corresponds to the external_budget_id of a campaign budget. If the value is not set in the campaign budget, this field will be empty.
+          "preTaxAmountMicros": "A String", # The sum of charges made under this budget before taxes, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
+          "prismaCpeCode": { # Google Payments Center supports searching and filtering on the component fields of this code. # Relevant client, product, and estimate codes from the Mediaocean Prisma tool. Only applicable for campaign budgets with an external_budget_source of EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN.
             "prismaClientCode": "A String", # The Prisma client code.
             "prismaEstimateCode": "A String", # The Prisma estimate code.
             "prismaProductCode": "A String", # The Prisma product code.
           },
-          "taxAmountMicros": "A String", # Output only. The tax amount for this budget, in micros of the invoice's currency. For example if currency_code is `USD`, then 1000000 micros is one US dollar.
-          "totalAmountMicros": "A String", # Output only. The total amount of charges for this budget, in micros of the invoice's currency. For example if currency_code is `USD`, then 1000000 micros is one US dollar.
+          "taxAmountMicros": "A String", # The amount of tax applied to charges under this budget, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
+          "totalAmountMicros": "A String", # The total sum of charges made under this budget, including tax, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
         },
       ],
-      "correctedInvoiceId": "A String", # Output only. The originally issued invoice that is being adjusted by this invoice, if applicable. If there is a corrected invoice, the replaced_invoice_ids field will be empty. May appear on invoice PDF as `Reference invoice number`.
-      "currencyCode": "A String", # Output only. Invoice currency code in ISO 4217 format.
-      "displayName": "A String", # Output only. Display name of the invoice.
-      "dueDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Output only. The invoice due date.
+      "correctedInvoiceId": "A String", # The ID of the original invoice being adjusted by this invoice, if applicable. May appear on the invoice PDF as `Reference invoice number`. If replaced_invoice_ids is set, this field will be empty.
+      "currencyCode": "A String", # The currency used in the invoice in ISO 4217 format.
+      "displayName": "A String", # The display name of the invoice.
+      "dueDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date when the invoice is due.
         "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
         "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
         "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
       },
-      "invoiceId": "A String", # Output only. The unique ID of the invoice.
-      "invoiceType": "A String", # Output only. The type of invoice document.
-      "issueDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Output only. The date when the invoice was issued.
+      "invoiceId": "A String", # The unique ID of the invoice.
+      "invoiceType": "A String", # The type of invoice document.
+      "issueDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The date when the invoice was issued.
         "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
         "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
         "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
       },
-      "name": "A String", # Output only. The resource name of the invoice.
-      "nonBudgetMicros": "A String", # Output only. The total amount of costs or adjustments not tied to a particular budget, in micros of the invoice's currency. For example if currency_code is `USD`, then 1000000 micros is one US dollar.
-      "paymentsAccountId": "A String", # Output only. The ID of the payments account the invoice belongs to. Appears on the invoice PDF as `Billing Account Number`.
-      "paymentsProfileId": "A String", # Output only. The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as `Billing ID`.
-      "pdfUrl": "A String", # Output only. The URL to download a PDF copy of the invoice. Note that this URL is user specific and requires a valid OAuth 2.0 access token to access. The access token must be provided in an `Authorization: Bearer` HTTP header and be authorized for one of the following scopes: * `https://www.googleapis.com/auth/display-video-mediaplanning` * `https://www.googleapis.com/auth/display-video` The URL will only be usable for 7 days from when the api is called.
-      "purchaseOrderNumber": "A String", # Output only. Purchase order number associated with the invoice.
-      "replacedInvoiceIds": [ # Output only. The originally issued invoice(s) that is being cancelled by this invoice, if applicable. If there are any replaced invoices, the corrected_invoice_id field will be empty. May appear on invoice PDF as `Replaced invoice numbers`. Note: There may be multiple replaced invoices due to consolidation of multiple invoices into a single invoice.
+      "name": "A String", # The resource name of the invoice.
+      "nonBudgetMicros": "A String", # The total amount of costs or adjustments not tied to a particular budget, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
+      "paymentsAccountId": "A String", # The ID of the payments account the invoice belongs to. Appears on the invoice PDF as `Billing Account Number`.
+      "paymentsProfileId": "A String", # The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as `Billing ID`.
+      "pdfUrl": "A String", # The URL to download a PDF copy of the invoice. This URL is user specific and requires a valid OAuth 2.0 access token to access. The access token must be provided in an `Authorization: Bearer` HTTP header and be authorized for one of the following scopes: * `https://www.googleapis.com/auth/display-video-mediaplanning` * `https://www.googleapis.com/auth/display-video` The URL will be valid for 7 days after retrieval of this invoice object or until this invoice is retrieved again.
+      "purchaseOrderNumber": "A String", # Purchase order number associated with the invoice.
+      "replacedInvoiceIds": [ # The ID(s) of any originally issued invoice that is being cancelled by this invoice, if applicable. Multiple invoices may be listed if those invoices are being consolidated into a single invoice. May appear on invoice PDF as `Replaced invoice numbers`. If corrected_invoice_id is set, this field will be empty.
         "A String",
       ],
-      "serviceDateRange": { # A date range. # Output only. Service start and end dates which are covered by this invoice.
+      "serviceDateRange": { # A date range. # The service start and end dates which are covered by this invoice.
         "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
           "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
           "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
@@ -167,12 +167,12 @@ 
Method Details

           "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
         },
       },
-      "subtotalAmountMicros": "A String", # Output only. The pre-tax subtotal amount, in micros of the invoice's currency. For example if currency_code is `USD`, then 1000000 micros is one US dollar.
-      "totalAmountMicros": "A String", # Output only. The invoice total amount, in micros of the invoice's currency. For example if currency_code is `USD`, then 1000000 micros is one US dollar.
-      "totalTaxAmountMicros": "A String", # Output only. The sum of all taxes in invoice, in micros of the invoice's currency. For example if currency_code is `USD`, then 1000000 micros is one US dollar.
+      "subtotalAmountMicros": "A String", # The pre-tax subtotal amount, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
+      "totalAmountMicros": "A String", # The invoice total amount, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
+      "totalTaxAmountMicros": "A String", # The sum of all taxes in invoice, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.
     },
   ],
-  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the [ListInvoicesRequest.page_token] field in the subsequent call to `ListInvoices` method to retrieve the next page of results.
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInvoices` method to retrieve the next page of results. This token will be absent if there are no more invoices to return.
 }
@@ -192,11 +192,11 @@

Method Details

lookupInvoiceCurrency(advertiserId, invoiceMonth=None, x__xgafv=None) - 
Lookup invoice currency for an advertiser.
+  
Retrieves the invoice currency used by an advertiser in a given month.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser to lookup currency for. (required)
-  invoiceMonth: string, Month for which currency is needed in the format YYYYMM. If not set Api would return currency based on current settings.
+  invoiceMonth: string, Month for which the currency is needed. If not set, the request will return existing currency settings for the advertiser. Must be in the format YYYYMM.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -205,8 +205,8 @@ 
Method Details

 Returns:
   An object of the form:
 
-    { # Response message for InvoiceService.LookupInvoiceCurrency.
-  "currencyCode": "A String", # Output only. Invoice currency code in ISO 4217 format.
+    {
+  "currencyCode": "A String", # Currency used by the advertiser in ISO 4217 format.
 }
diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v1.json b/googleapiclient/discovery_cache/documents/displayvideo.v1.json index 75edbc972c4..fb7156d30e1 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v1.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v1.json @@ -2114,7 +2114,7 @@ "invoices": { "methods": { "list": { - "description": "List invoices for an advertiser.", + "description": "Lists invoices posted for an advertiser in a given month. Invoices generated by billing profiles with a \"Partner\" invoice level are not retrievable through this method.", "flatPath": "v1/advertisers/{advertisersId}/invoices", "httpMethod": "GET", "id": "displayvideo.advertisers.invoices.list", @@ -2131,12 +2131,12 @@ "type": "string" }, "issueMonth": { - "description": "Required. Month for which invoices are needed in the format YYYYMM.", + "description": "The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM.", "location": "query", "type": "string" }, "loiSapinInvoiceType": { - "description": "Select type of invoice to query for Loi Sapin advertisers. Otherwise its ignored.", + "description": "Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.", "enum": [ "LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED", "LOI_SAPIN_INVOICE_TYPE_MEDIA", @@ -2157,7 +2157,7 @@ "type": "integer" }, "pageToken": { - "description": "A token identifying a page of results the server should return. Typically, this is the value of [ListInvoicesResponse.next_page_token] returned from the previous call to `ListInvoice` method. If not specified, the first page of results will be returned.", + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInvoices` method. If not specified, the first page of results will be returned.", "location": "query", "type": "string" } @@ -2172,7 +2172,7 @@ ] }, "lookupInvoiceCurrency": { - "description": "Lookup invoice currency for an advertiser.", + "description": "Retrieves the invoice currency used by an advertiser in a given month.", "flatPath": "v1/advertisers/{advertisersId}/invoices:lookupInvoiceCurrency", "httpMethod": "GET", "id": "displayvideo.advertisers.invoices.lookupInvoiceCurrency", @@ -2189,7 +2189,7 @@ "type": "string" }, "invoiceMonth": { - "description": "Month for which currency is needed in the format YYYYMM. If not set Api would return currency based on current settings.", + "description": "Month for which the currency is needed. If not set, the request will return existing currency settings for the advertiser. Must be in the format YYYYMM.", "location": "query", "type": "string" } @@ -7203,7 +7203,7 @@ } } }, - "revision": "20210524", + "revision": "20210603", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -7428,7 +7428,7 @@ "type": "string" }, "prismaEnabled": { - "description": "Whether integration with Mediaocean (Prisma) is enabled. By enabling this: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser.", + "description": "Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser.", "type": "boolean" }, "servingConfig": { @@ -8328,35 +8328,30 @@ "type": "object" }, "BudgetSummary": { - "description": "Represents a summarized budget information associated with this invoice.", + "description": "Summarized information of an individual campaign budget.", "id": "BudgetSummary", "properties": { "externalBudgetId": { - "description": "Output only. External budget id.", - "readOnly": true, + "description": "Corresponds to the external_budget_id of a campaign budget. If the value is not set in the campaign budget, this field will be empty.", "type": "string" }, "preTaxAmountMicros": { - "description": "Output only. The pre-tax amount for this budget, in micros of the invoice's currency. For example if currency_code is `USD`, then 1000000 micros is one US dollar.", + "description": "The sum of charges made under this budget before taxes, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", "format": "int64", - "readOnly": true, "type": "string" }, "prismaCpeCode": { "$ref": "PrismaCpeCode", - "description": "Output only. Codes specific to the MediaOcean Prisma tool.", - "readOnly": true + "description": "Relevant client, product, and estimate codes from the Mediaocean Prisma tool. Only applicable for campaign budgets with an external_budget_source of EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN." }, "taxAmountMicros": { - "description": "Output only. The tax amount for this budget, in micros of the invoice's currency. For example if currency_code is `USD`, then 1000000 micros is one US dollar.", + "description": "The amount of tax applied to charges under this budget, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", "format": "int64", - "readOnly": true, "type": "string" }, "totalAmountMicros": { - "description": "Output only. The total amount of charges for this budget, in micros of the invoice's currency. For example if currency_code is `USD`, then 1000000 micros is one US dollar.", + "description": "The total sum of charges made under this budget, including tax, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", "format": "int64", - "readOnly": true, "type": "string" } }, @@ -8741,7 +8736,7 @@ "type": "string" }, "campaignBudgets": { - "description": "The list of budgets available to this campaign. Setting no budget gives an unlimited campaign budget.", + "description": "The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget.", "items": { "$ref": "CampaignBudget" }, @@ -8808,17 +8803,17 @@ "id": "CampaignBudget", "properties": { "budgetAmountMicros": { - "description": "Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.", + "description": "Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.", "format": "int64", "type": "string" }, "budgetId": { - "description": "The unique ID of the campaign budget. If not included, budget is assumed to be new.", + "description": "The unique ID of the campaign budget. Assigned by the system. Do not set for new budgets. Must be included when updating or adding budgets to campaign_budgets. Otherwise, a new ID will be generated and assigned.", "format": "int64", "type": "string" }, "budgetUnit": { - "description": "Required. Immutable. The budget unit specifies whether the budget is currency based or impression based.", + "description": "Required. Immutable. Specifies whether the budget is measured in currency or impressions.", "enum": [ "BUDGET_UNIT_UNSPECIFIED", "BUDGET_UNIT_CURRENCY", @@ -8833,18 +8828,18 @@ }, "dateRange": { "$ref": "DateRange", - "description": "Required. The flight start and end time settings of the segment. Both `start_date` and `end_date` must be before the year 2037." + "description": "Required. The date range for the campaign budget. Linked budget segments may have a different date range. They are resolved relative to the parent advertiser's time zone. Both `start_date` and `end_date` must be before the year 2037." }, "displayName": { "description": "Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes.", "type": "string" }, "externalBudgetId": { - "description": "Immutable. Must be unique under the campaign. If set, all impressions served against this budget will include this ID on the invoice if the customer has opted into budget-segment-level billing.", + "description": "Immutable. The ID identifying this budget to the external source. If this field is set and the invoice detail level of the corresponding billing profile is set to \"Budget level PO\", all impressions served against this budget will include this ID on the invoice. Must be unique under the campaign.", "type": "string" }, "externalBudgetSource": { - "description": "Required. The external source of the budget segment.", + "description": "Required. The external source of the budget.", "enum": [ "EXTERNAL_BUDGET_SOURCE_UNSPECIFIED", "EXTERNAL_BUDGET_SOURCE_NONE", @@ -8853,17 +8848,17 @@ "enumDescriptions": [ "External budget source value is not specified or unknown in this version.", "Budget has no external source.", - "Budget source is MediaOcean." + "Budget source is Mediaocean." ], "type": "string" }, "invoiceGroupingId": { - "description": "Immutable. If set, all external_budget_id sharing the same invoice_grouping_id will include this ID on the invoice if the customer has opted into budget-segment-level billing.", + "description": "Immutable. The ID used to group budgets to be included the same invoice. If this field is set and the invoice level of the corresponding billing profile is set to \"Budget invoice grouping ID\", all external_budget_id sharing the same invoice_grouping_id will be grouped in the same invoice.", "type": "string" }, "prismaConfig": { "$ref": "PrismaConfig", - "description": "Required for MediaOcean budgets. Additional metadata set by the MediaOcean Prisma tool." + "description": "Additional metadata for use by the Mediaocean Prisma tool. Required for Mediaocean budgets. Only applicable to prisma_enabled advertisers." } }, "type": "object" @@ -12313,7 +12308,7 @@ "type": "string" }, "campaignBudgetId": { - "description": "The ID of the campaign budget linked to this insertion order budget segment.", + "description": "The budget_id of the campaign budget that this insertion order budget segment is a part of.", "format": "int64", "type": "string" }, @@ -12938,49 +12933,42 @@ "type": "object" }, "Invoice": { - "description": "A single Invoice.", + "description": "A single invoice.", "id": "Invoice", "properties": { "budgetInvoiceGroupingId": { - "description": "Output only. Budget invoice grouping ID associated with the budget segment in the insertion order.", - "readOnly": true, + "description": "The budget grouping ID for this invoice. This field will only be set if the invoice level of the corresponding billing profile was set to \"Budget invoice grouping ID\".", "type": "string" }, "budgetSummaries": { - "description": "Output only. The list of summarized budget information associated with this invoice.", + "description": "The list of summarized information for each budget associated with this invoice. This field will only be set if the invoice detail level of the corresponding billing profile was set to \"Budget level PO\".", "items": { "$ref": "BudgetSummary" }, - "readOnly": true, "type": "array" }, "correctedInvoiceId": { - "description": "Output only. The originally issued invoice that is being adjusted by this invoice, if applicable. If there is a corrected invoice, the replaced_invoice_ids field will be empty. May appear on invoice PDF as `Reference invoice number`.", - "readOnly": true, + "description": "The ID of the original invoice being adjusted by this invoice, if applicable. May appear on the invoice PDF as `Reference invoice number`. If replaced_invoice_ids is set, this field will be empty.", "type": "string" }, "currencyCode": { - "description": "Output only. Invoice currency code in ISO 4217 format.", - "readOnly": true, + "description": "The currency used in the invoice in ISO 4217 format.", "type": "string" }, "displayName": { - "description": "Output only. Display name of the invoice.", - "readOnly": true, + "description": "The display name of the invoice.", "type": "string" }, "dueDate": { "$ref": "Date", - "description": "Output only. The invoice due date.", - "readOnly": true + "description": "The date when the invoice is due." }, "invoiceId": { - "description": "Output only. The unique ID of the invoice.", - "readOnly": true, + "description": "The unique ID of the invoice.", "type": "string" }, "invoiceType": { - "description": "Output only. The type of invoice document.", + "description": "The type of invoice document.", "enum": [ "INVOICE_TYPE_UNSPECIFIED", "INVOICE_TYPE_CREDIT", @@ -12988,77 +12976,64 @@ ], "enumDescriptions": [ "Not specified or is unknown in this version.", - "An Invoice with a negative amount.", - "An Invoice with a positive amount." + "The invoice has a negative amount.", + "The invoice has a positive amount." ], - "readOnly": true, "type": "string" }, "issueDate": { "$ref": "Date", - "description": "Output only. The date when the invoice was issued.", - "readOnly": true + "description": "The date when the invoice was issued." }, "name": { - "description": "Output only. The resource name of the invoice.", - "readOnly": true, + "description": "The resource name of the invoice.", "type": "string" }, "nonBudgetMicros": { - "description": "Output only. The total amount of costs or adjustments not tied to a particular budget, in micros of the invoice's currency. For example if currency_code is `USD`, then 1000000 micros is one US dollar.", + "description": "The total amount of costs or adjustments not tied to a particular budget, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", "format": "int64", - "readOnly": true, "type": "string" }, "paymentsAccountId": { - "description": "Output only. The ID of the payments account the invoice belongs to. Appears on the invoice PDF as `Billing Account Number`.", - "readOnly": true, + "description": "The ID of the payments account the invoice belongs to. Appears on the invoice PDF as `Billing Account Number`.", "type": "string" }, "paymentsProfileId": { - "description": "Output only. The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as `Billing ID`.", - "readOnly": true, + "description": "The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as `Billing ID`.", "type": "string" }, "pdfUrl": { - "description": "Output only. The URL to download a PDF copy of the invoice. Note that this URL is user specific and requires a valid OAuth 2.0 access token to access. The access token must be provided in an `Authorization: Bearer` HTTP header and be authorized for one of the following scopes: * `https://www.googleapis.com/auth/display-video-mediaplanning` * `https://www.googleapis.com/auth/display-video` The URL will only be usable for 7 days from when the api is called.", - "readOnly": true, + "description": "The URL to download a PDF copy of the invoice. This URL is user specific and requires a valid OAuth 2.0 access token to access. The access token must be provided in an `Authorization: Bearer` HTTP header and be authorized for one of the following scopes: * `https://www.googleapis.com/auth/display-video-mediaplanning` * `https://www.googleapis.com/auth/display-video` The URL will be valid for 7 days after retrieval of this invoice object or until this invoice is retrieved again.", "type": "string" }, "purchaseOrderNumber": { - "description": "Output only. Purchase order number associated with the invoice.", - "readOnly": true, + "description": "Purchase order number associated with the invoice.", "type": "string" }, "replacedInvoiceIds": { - "description": "Output only. The originally issued invoice(s) that is being cancelled by this invoice, if applicable. If there are any replaced invoices, the corrected_invoice_id field will be empty. May appear on invoice PDF as `Replaced invoice numbers`. Note: There may be multiple replaced invoices due to consolidation of multiple invoices into a single invoice.", + "description": "The ID(s) of any originally issued invoice that is being cancelled by this invoice, if applicable. Multiple invoices may be listed if those invoices are being consolidated into a single invoice. May appear on invoice PDF as `Replaced invoice numbers`. If corrected_invoice_id is set, this field will be empty.", "items": { "type": "string" }, - "readOnly": true, "type": "array" }, "serviceDateRange": { "$ref": "DateRange", - "description": "Output only. Service start and end dates which are covered by this invoice.", - "readOnly": true + "description": "The service start and end dates which are covered by this invoice." }, "subtotalAmountMicros": { - "description": "Output only. The pre-tax subtotal amount, in micros of the invoice's currency. For example if currency_code is `USD`, then 1000000 micros is one US dollar.", + "description": "The pre-tax subtotal amount, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", "format": "int64", - "readOnly": true, "type": "string" }, "totalAmountMicros": { - "description": "Output only. The invoice total amount, in micros of the invoice's currency. For example if currency_code is `USD`, then 1000000 micros is one US dollar.", + "description": "The invoice total amount, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", "format": "int64", - "readOnly": true, "type": "string" }, "totalTaxAmountMicros": { - "description": "Output only. The sum of all taxes in invoice, in micros of the invoice's currency. For example if currency_code is `USD`, then 1000000 micros is one US dollar.", + "description": "The sum of all taxes in invoice, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", "format": "int64", - "readOnly": true, "type": "string" } }, @@ -13684,7 +13659,6 @@ "type": "object" }, "ListInvoicesResponse": { - "description": "Response message for InvoiceService.ListInvoices.", "id": "ListInvoicesResponse", "properties": { "invoices": { @@ -13695,7 +13669,7 @@ "type": "array" }, "nextPageToken": { - "description": "A token to retrieve the next page of results. Pass this value in the [ListInvoicesRequest.page_token] field in the subsequent call to `ListInvoices` method to retrieve the next page of results.", + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListInvoices` method to retrieve the next page of results. This token will be absent if there are no more invoices to return.", "type": "string" } }, @@ -13952,12 +13926,10 @@ "type": "object" }, "LookupInvoiceCurrencyResponse": { - "description": "Response message for InvoiceService.LookupInvoiceCurrency.", "id": "LookupInvoiceCurrencyResponse", "properties": { "currencyCode": { - "description": "Output only. Invoice currency code in ISO 4217 format.", - "readOnly": true, + "description": "Currency used by the advertiser in ISO 4217 format.", "type": "string" } }, @@ -14950,12 +14922,12 @@ "type": "object" }, "PrismaConfig": { - "description": "Settings specific to the MediaOcean Prisma tool.", + "description": "Settings specific to the Mediaocean Prisma tool.", "id": "PrismaConfig", "properties": { "prismaCpeCode": { "$ref": "PrismaCpeCode", - "description": "Required. Google Payments Center supports searching and filtering on this code." + "description": "Required. Relevant client, product, and estimate codes from the Mediaocean Prisma tool." }, "prismaType": { "description": "Required. The Prisma type.",