| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="searchads360_v23.html">Search Ads 360 Reporting API</a> . <a href="searchads360_v23.v23.html">v23</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#generateConversionRates">generateConversionRates(body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns a collection of conversion rate suggestions for supported plannable products. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()</p> |
| <p class="toc_element"> |
| <code><a href="#listBenchmarksAvailableDates">listBenchmarksAvailableDates(body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns a date range that supports benchmarks. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()</p> |
| <p class="toc_element"> |
| <code><a href="#listBenchmarksLocations">listBenchmarksLocations(body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns the list of locations that support benchmarks (for example, countries). List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()</p> |
| <p class="toc_element"> |
| <code><a href="#listBenchmarksProducts">listBenchmarksProducts(body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns the list of products that supports benchmarks. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()</p> |
| <p class="toc_element"> |
| <code><a href="#listBenchmarksSources">listBenchmarksSources(body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns the list of benchmarks sources (for example, Industry Verticals). List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()</p> |
| <p class="toc_element"> |
| <code><a href="#listPlannableLocations">listPlannableLocations(body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns the list of plannable locations (for example, countries). List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()</p> |
| <p class="toc_element"> |
| <code><a href="#listPlannableProducts">listPlannableProducts(body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns the list of per-location plannable YouTube ad formats with allowed targeting. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]()</p> |
| <p class="toc_element"> |
| <code><a href="#listPlannableUserInterests">listPlannableUserInterests(body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns the list of plannable user interests. A plannable user interest is one that can be targeted in a reach forecast using ReachPlanService.GenerateReachForecast. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [ListOperationError]() [QuotaError]() [RequestError]() [StringLengthError]()</p> |
| <p class="toc_element"> |
| <code><a href="#listPlannableUserLists">listPlannableUserLists(body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns the list of plannable user lists with their plannable status. User lists may not be plannable for a number of reasons, including: - They are less than 10 days old. - They have a membership lifespan that is less than 30 days - They have less than 10,000 or more than 700,000 users. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [ReachPlanError]() [RequestError]()</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="generateConversionRates">generateConversionRates(body=None, x__xgafv=None)</code> |
| <pre>Returns a collection of conversion rate suggestions for supported plannable products. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() |
| |
| Args: |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for ReachPlanService.GenerateConversionRates. |
| "customerId": "A String", # Required. The ID of the customer. A conversion rate based on the historical data of this customer may be suggested. |
| "customerReachGroup": "A String", # The name of the customer being planned for. This is a user-defined value. |
| "reachApplicationInfo": { # Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs. # Optional. Additional information on the application issuing the request. |
| "applicationId": "A String", # The unique identifier of the agency proprietary application. This identifier is generated by Google. Reach out to your Google representative to request an application_id for each new application being integrated. |
| "applicationInstance": "A String", # The instance type of the application sending the request. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for ReachPlanService.GenerateConversionRates, containing conversion rate suggestions for supported plannable products. |
| "conversionRateSuggestions": [ # A list containing conversion rate suggestions. Each repeated element will have an associated product code. Multiple suggestions may share the same product code. |
| { # A conversion rate suggestion. |
| "conversionRate": 3.14, # The suggested conversion rate. The value is between 0 and 1 (exclusive). |
| "conversionRateModel": "A String", # Model type used to calculate the suggested conversion rate. |
| "plannableProductCode": "A String", # The code associated with the plannable product (for example: DEMAND_GEN). To list all plannable product codes, use ReachPlanService.ListPlannableProducts. |
| "surfaceTargeting": { # Container for surfaces for a product. Surfaces refer to the available types of ad inventories such as In-Feed, In-Stream, and Shorts. # The surfaces associated with the plannable product. If not present, the conversion rate is considered surface agnostic for this product. |
| "surfaces": [ # List of surfaces available to target. |
| "A String", |
| ], |
| }, |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listBenchmarksAvailableDates">listBenchmarksAvailableDates(body=None, x__xgafv=None)</code> |
| <pre>Returns a date range that supports benchmarks. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() |
| |
| Args: |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for BenchmarksService.ListBenchmarksAvailableDates. |
| "applicationInfo": { # Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs. # Additional information on the application issuing the request. |
| "applicationId": "A String", # The unique identifier of the agency proprietary application. This identifier is generated by Google. Reach out to your Google representative to request an application_id for each new application being integrated. |
| "applicationInstance": "A String", # The instance type of the application sending the request. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for BenchmarksService.ListBenchmarksAvailableDates. |
| "supportedDates": { # A date range. # The dates that support benchmarks metrics. Data is supported for any dates within this date range inclusive. |
| "endDate": "A String", # The end date, in yyyy-mm-dd format. This date is inclusive. |
| "startDate": "A String", # The start date, in yyyy-mm-dd format. This date is inclusive. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listBenchmarksLocations">listBenchmarksLocations(body=None, x__xgafv=None)</code> |
| <pre>Returns the list of locations that support benchmarks (for example, countries). List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() |
| |
| Args: |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for BenchmarksService.ListBenchmarksLocations. |
| "applicationInfo": { # Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs. # Additional information on the application issuing the request. |
| "applicationId": "A String", # The unique identifier of the agency proprietary application. This identifier is generated by Google. Reach out to your Google representative to request an application_id for each new application being integrated. |
| "applicationInstance": "A String", # The instance type of the application sending the request. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for BenchmarksService.ListBenchmarksLocations. |
| "benchmarksLocations": [ # The list of locations supported for benchmarks data. |
| { # A location that supports benchmarks data. |
| "locationInfo": { # A location criterion. # Information on the geographic location, including the location ID. |
| "geoTargetConstant": "A String", # The geo target constant resource name. |
| }, |
| "locationName": "A String", # The unique location name in English. |
| "locationType": "A String", # The location's type. Location types correspond to target_type returned by searching location type in GoogleAdsService.Search/SearchStream. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listBenchmarksProducts">listBenchmarksProducts(body=None, x__xgafv=None)</code> |
| <pre>Returns the list of products that supports benchmarks. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() |
| |
| Args: |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for BenchmarksService.ListBenchmarksProducts. |
| "applicationInfo": { # Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs. # Additional information on the application issuing the request. |
| "applicationId": "A String", # The unique identifier of the agency proprietary application. This identifier is generated by Google. Reach out to your Google representative to request an application_id for each new application being integrated. |
| "applicationInstance": "A String", # The instance type of the application sending the request. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for BenchmarksService.ListBenchmarksProducts. |
| "benchmarksProducts": [ # The list of products available for benchmarks data. |
| { # The metadata associated with a product supported for benchmarks data. |
| "marketingObjective": "A String", # The marketing objective associated with the product. A marketing objective is a broader classification of products. |
| "productCode": "A String", # The identifier of the product. The identifier can be used as inputs for BenchmarksService.GenerateBenchmarksMetrics. |
| "productName": "A String", # The name of the product. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listBenchmarksSources">listBenchmarksSources(body=None, x__xgafv=None)</code> |
| <pre>Returns the list of benchmarks sources (for example, Industry Verticals). List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() |
| |
| Args: |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for BenchmarksService.ListBenchmarksSources. |
| "applicationInfo": { # Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs. # Additional information on the application issuing the request. |
| "applicationId": "A String", # The unique identifier of the agency proprietary application. This identifier is generated by Google. Reach out to your Google representative to request an application_id for each new application being integrated. |
| "applicationInstance": "A String", # The instance type of the application sending the request. |
| }, |
| "benchmarksSources": [ # Required. The types of benchmarks sources to be returned (for example, INDUSTRY_VERTICAL). |
| "A String", |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for BenchmarksService.ListBenchmarksSources. |
| "benchmarksSources": [ # The list of available source used to generate benchmarks data for. |
| { # The metadata associated with a benchmarks source. |
| "benchmarksSourceType": "A String", # The type of benchmarks source. |
| "industryVerticalInfo": { # The information associated with an Industry Vertical. # Information on the Industry Vertical. |
| "industryVerticalId": "A String", # The unique identifier of the Industry Vertical. |
| "industryVerticalName": "A String", # The name of the Industry Vertical. |
| "parentIndustryVerticalId": "A String", # The unique identifier of the parent Industry Vertical, if exists. |
| }, |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listPlannableLocations">listPlannableLocations(body=None, x__xgafv=None)</code> |
| <pre>Returns the list of plannable locations (for example, countries). List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() |
| |
| Args: |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for ReachPlanService.ListPlannableLocations. |
| "reachApplicationInfo": { # Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs. # Optional. Additional information on the application issuing the request. |
| "applicationId": "A String", # The unique identifier of the agency proprietary application. This identifier is generated by Google. Reach out to your Google representative to request an application_id for each new application being integrated. |
| "applicationInstance": "A String", # The instance type of the application sending the request. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The list of plannable locations. |
| "plannableLocations": [ # The list of locations available for planning. See https://developers.google.com/google-ads/api/reference/data/geotargets for sample locations. |
| { # A plannable location: country, metro region, province, etc. |
| "countryCode": "A String", # The ISO-3166-1 alpha-2 country code that is associated with the location. |
| "id": "A String", # The location identifier. |
| "locationType": "A String", # The location's type. Location types correspond to target_type returned by . |
| "name": "A String", # The unique location name in English. |
| "parentCountryId": "A String", # The parent country (not present if location is a country). If present, will always be a GeoTargetConstant ID. Additional information such as country name is provided by ReachPlanService.ListPlannableLocations or |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listPlannableProducts">listPlannableProducts(body=None, x__xgafv=None)</code> |
| <pre>Returns the list of per-location plannable YouTube ad formats with allowed targeting. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [HeaderError]() [InternalError]() [QuotaError]() [RequestError]() |
| |
| Args: |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request to list available products in a given location. |
| "plannableLocationId": "A String", # Required. The ID of the selected location for planning. To list the available plannable location IDs use ReachPlanService.ListPlannableLocations. |
| "reachApplicationInfo": { # Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs. # Optional. Additional information on the application issuing the request. |
| "applicationId": "A String", # The unique identifier of the agency proprietary application. This identifier is generated by Google. Reach out to your Google representative to request an application_id for each new application being integrated. |
| "applicationInstance": "A String", # The instance type of the application sending the request. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A response with all available products. |
| "productMetadata": [ # The list of products available for planning and related targeting metadata. |
| { # The metadata associated with an available plannable product. |
| "plannableProductCode": "A String", # The code associated with the ad product (for example: BUMPER, TRUEVIEW_IN_STREAM). To list the available plannable product codes use ReachPlanService.ListPlannableProducts. |
| "plannableProductName": "A String", # The name associated with the ad product. |
| "plannableTargeting": { # The targeting for which traffic metrics will be reported. # The allowed plannable targeting for this product. |
| "ageRanges": [ # Allowed plannable age ranges for the product for which metrics will be reported. Actual targeting is computed by mapping this age range onto standard Google common.AgeRangeInfo values. |
| "A String", |
| ], |
| "devices": [ # Targetable devices for the ad product. TABLET device targeting is automatically applied to reported metrics when MOBILE targeting is selected for CPM_MASTHEAD, GOOGLE_PREFERRED_BUMPER, and GOOGLE_PREFERRED_SHORT products. |
| { # A device criterion. |
| "type": "A String", # Type of the device. |
| }, |
| ], |
| "genders": [ # Targetable genders for the ad product. |
| { # A gender criterion. |
| "type": "A String", # Type of the gender. |
| }, |
| ], |
| "networks": [ # Targetable networks for the ad product. |
| "A String", |
| ], |
| "surfaceTargeting": { # The surface targeting combinations available for an ad product. # Targetable surface combinations for the ad product. |
| "availableTargetingCombinations": [ # Available surface target combinations for the ad product. |
| { # Container for surfaces for a product. Surfaces refer to the available types of ad inventories such as In-Feed, In-Stream, and Shorts. |
| "surfaces": [ # List of surfaces available to target. |
| "A String", |
| ], |
| }, |
| ], |
| "defaultTargeting": { # Container for surfaces for a product. Surfaces refer to the available types of ad inventories such as In-Feed, In-Stream, and Shorts. # Default surface targeting applied to the ad product. |
| "surfaces": [ # List of surfaces available to target. |
| "A String", |
| ], |
| }, |
| }, |
| "youtubeSelectLineups": [ # Targetable YouTube Select Lineups for the ad product. |
| { # A Plannable YouTube Select Lineup for product targeting. |
| "lineupId": "A String", # The ID of the YouTube Select Lineup. |
| "lineupName": "A String", # The unique name of the YouTube Select Lineup. |
| }, |
| ], |
| }, |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listPlannableUserInterests">listPlannableUserInterests(body=None, x__xgafv=None)</code> |
| <pre>Returns the list of plannable user interests. A plannable user interest is one that can be targeted in a reach forecast using ReachPlanService.GenerateReachForecast. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [ListOperationError]() [QuotaError]() [RequestError]() [StringLengthError]() |
| |
| Args: |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for ReachPlanService.ListPlannableUserInterests. |
| "customerId": "A String", # Required. The ID of the customer. |
| "nameQuery": "A String", # A filter by user interest name. If set, only user interests with a name containing the literal string (case insensitive) in the filter will be returned. Maximum length is 200 characters. |
| "pathQuery": "A String", # A filter by user interest path. If set, only user interests with a path containing the literal string (case insensitive) in the filter will be returned. Maximum length is 200 characters. |
| "reachApplicationInfo": { # Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs. # Optional. Additional information on the application issuing the request. |
| "applicationId": "A String", # The unique identifier of the agency proprietary application. This identifier is generated by Google. Reach out to your Google representative to request an application_id for each new application being integrated. |
| "applicationInstance": "A String", # The instance type of the application sending the request. |
| }, |
| "userInterestTaxonomyTypes": [ # Optional. A filter by user interest type. If set, only user interests with a type listed in the filter will be returned. If not set, user interests of all supported types will be returned. Supported user interest types are AFFINITY and IN_MARKET. Each type must be specified at most once. |
| "A String", |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for ReachPlanService.ListPlannableUserInterests. |
| "plannableUserInterests": [ # The list of plannable user interests. |
| { # A plannable user interest that can be targeted in a reach forecast using ReachPlanService.GenerateReachForecast. |
| "userInterest": { # Represents a particular interest-based topic to be targeted. # The user interest id. |
| "userInterestCategory": "A String", # The UserInterest resource name. |
| }, |
| "userInterestDisplayName": "A String", # The user interest display name. For example, "Autos & Vehicles" |
| "userInterestPath": "A String", # The user interest path. For example, "/Autos & Vehicles/Motor Vehicles/Motor Vehicles by Type/Off-Road Vehicles" |
| "userInterestType": "A String", # The user interest type. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="listPlannableUserLists">listPlannableUserLists(body=None, x__xgafv=None)</code> |
| <pre>Returns the list of plannable user lists with their plannable status. User lists may not be plannable for a number of reasons, including: - They are less than 10 days old. - They have a membership lifespan that is less than 30 days - They have less than 10,000 or more than 700,000 users. List of thrown errors: [AuthenticationError]() [AuthorizationError]() [FieldError]() [HeaderError]() [InternalError]() [QuotaError]() [RangeError]() [ReachPlanError]() [RequestError]() |
| |
| Args: |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for ReachPlanService.ListPlannableUserLists that lists the available user lists for a customer. |
| "customerId": "A String", # Required. The ID of the customer. |
| "customerReachGroup": "A String", # The name of the customer being planned for. This is a user-defined value. |
| "reachApplicationInfo": { # Additional information about the application/tool issuing the request. This field is only used by ContentCreatorInsightsService, AudienceInsightsService, and ReachPlanService APIs. # Optional. Additional information on the application issuing the request. |
| "applicationId": "A String", # The unique identifier of the agency proprietary application. This identifier is generated by Google. Reach out to your Google representative to request an application_id for each new application being integrated. |
| "applicationInstance": "A String", # The instance type of the application sending the request. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A response with all available user lists with their plannable status. |
| "plannableUserLists": [ # The list of user lists available for planning and related targeting metadata. |
| { # A plannable user list. |
| "displayName": "A String", # The name of the user list. |
| "plannableStatus": "A String", # The plannable status of the user list. |
| "plannableUserListMetadata": { # The metadata associated with a plannable user list. # The relevant metadata for this user list. |
| "userListCrmDataSourceType": "A String", # The data source type of a CRM based user list. |
| }, |
| "userListInfo": { # A User List criterion. Represents a user list that is defined by the advertiser to be targeted. # The user list ID. |
| "userList": "A String", # The User List resource name. |
| }, |
| "userListType": "A String", # The user list type. |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| </body></html> |
